On this page
WP_REST_Users_Controller::update_item_permissions_check( WP_REST_Request $request ): true|WP_Error
Checks if a given request has access to update a user.
Parameters
$requestWP_REST_Request Required-
Full details about the request.
Return
true|WP_Error True if the request has access to update the item, WP_Error object otherwise.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php. View all references
public function update_item_permissions_check( $request ) {
$user = $this->get_user( $request['id'] );
if ( is_wp_error( $user ) ) {
return $user;
}
if ( ! empty( $request['roles'] ) ) {
if ( ! current_user_can( 'promote_user', $user->ID ) ) {
return new WP_Error(
'rest_cannot_edit_roles',
__( 'Sorry, you are not allowed to edit roles of this user.' ),
array( 'status' => rest_authorization_required_code() )
);
}
$request_params = array_keys( $request->get_params() );
sort( $request_params );
// If only 'id' and 'roles' are specified (we are only trying to
// edit roles), then only the 'promote_user' cap is required.
if ( array( 'id', 'roles' ) === $request_params ) {
return true;
}
}
if ( ! current_user_can( 'edit_user', $user->ID ) ) {
return new WP_Error(
'rest_cannot_edit',
__( 'Sorry, you are not allowed to edit this user.' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
Related
Uses
| Uses | Description |
|---|---|
| WP_REST_Users_Controller::get_user() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Get the user, if the ID is valid. |
| rest_authorization_required_code() wp-includes/rest-api.php | Returns a contextual HTTP error code for authorization failure. |
| current_user_can() wp-includes/capabilities.php | Returns whether the current user has the specified capability. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| is_wp_error() wp-includes/load.php | Checks whether the given variable is a WordPress Error. |
| WP_Error::__construct() wp-includes/class-wp-error.php | Initializes the error. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Users_Controller::update_current_item_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Checks if a given request has access to update the current user. |
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_users_controller/update_item_permissions_check