WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Users_Controller::get_user()

WP_REST_Users_Controller::get_user( int $id ): WP_User|WP_Error

In this article

Back to top

Get the user, if the ID is valid.

Parameters

$idintrequired
Supplied ID.

Return

WP_User|WP_Error True if ID is valid, WP_Error otherwise.

Source

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; }

View all references View on Trac View on GitHub

UsesDescription
is_user_member_of_blog()wp-includes/user.php

Finds out whether a user is a member of a given blog.

get_userdata()wp-includes/pluggable.php

Retrieves user info by user ID.

is_multisite()wp-includes/load.php

Determines whether Multisite is enabled.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 2 moreShow less
Used byDescription
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.

Show 1 moreShow less

Changelog

VersionDescription
4.7.2Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.