WP_REST_Users_Controller::get_item() WordPress Method

The WP_REST_Users_Controller::get_item() method is used to retrieve a single user from the WordPress database. This method accepts two parameters: the user ID and the fields to be returned. The user ID is required, but the fields parameter is optional. If no fields are specified, all available fields will be returned.

WP_REST_Users_Controller::get_item( WP_REST_Request $request ) #

Retrieves a single user.


Parameters

$request

(WP_REST_Request)(Required)Full details about the request.


Top ↑

Return

(WP_REST_Response|WP_Error) Response object on success, or WP_Error object on failure.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

	public function get_item( $request ) {
		$user = $this->get_user( $request['id'] );
		if ( is_wp_error( $user ) ) {
			return $user;
		}

		$user     = $this->prepare_item_for_response( $user, $request );
		$response = rest_ensure_response( $user );

		return $response;
	}


Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.