WP_REST_Users_Controller::update_item_permissions_check() WordPress Method
The WP_REST_Users_Controller::update_item_permissions_check() method is used to check if a given user can update a user. This is a method of the WP_REST_Users_Controller class. It is used to check if a given user can update a user. The method takes two parameters, the user ID to check and the user object. The user object must have the 'edit_users' capability. The method returns true if the user can update the user, false otherwise.
WP_REST_Users_Controller::update_item_permissions_check( WP_REST_Request $request ) #
Checks if a given request has access to update a user.
Parameters
- $request
(WP_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
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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |