On this page
WP_REST_Users_Controller::get_user( int $id ): WP_User|WP_Error
Get the user, if the ID is valid.
Parameters
$idint Required-
Supplied ID.
Return
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php. View all references
protected function get_user( $id ) {
$error = new WP_Error(
'rest_user_invalid_id',
__( 'Invalid user ID.' ),
array( 'status' => 404 )
);
if ( (int) $id <= 0 ) {
return $error;
}
$user = get_userdata( (int) $id );
if ( empty( $user ) || ! $user->exists() ) {
return $error;
}
if ( is_multisite() && ! is_user_member_of_blog( $user->ID ) ) {
return $error;
}
return $user;
}
Related
Uses
| Uses | Description |
|---|---|
| is_user_member_of_blog() wp-includes/user.php | Finds out whether a user is a member of a given blog. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| get_userdata() wp-includes/pluggable.php | Retrieves user info by user ID. |
| is_multisite() wp-includes/load.php | If Multisite is enabled. |
| WP_Error::__construct() wp-includes/class-wp-error.php | Initializes the error. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Users_Controller::delete_item_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Checks if a given request has access delete a user. |
| WP_REST_Users_Controller::delete_item() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Deletes a single user. |
| WP_REST_Users_Controller::get_item() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Retrieves a single user. |
| WP_REST_Users_Controller::update_item_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Checks if a given request has access to update a user. |
| WP_REST_Users_Controller::update_item() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Updates a single user. |
| WP_REST_Users_Controller::get_item_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Checks if a given request has access to read a user. |
Changelog
| Version | Description |
|---|---|
| 4.7.2 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_users_controller/get_user