WP_REST_Users_Controller::prepare_item_for_response( WP_User $item, WP_REST_Request $request ): WP_REST_Response

Parameters

$itemWP_User

User object.

$requestWP_REST_Request

Request object.

Return

WP_REST_Response

Response object.

Hooks fired · 1

One hook fires while WP_REST_Users_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( rest_prepare_user )filterline 1105 (+101 into the body)

   Filters user data returned from the REST API.

Uses · 11

• get_author_posts_url()Retrieves the URL to the author page for the user with the ID provided.
• get_user_locale()Retrieves the locale of a user.
• current_user_can()Returns whether the current user has the specified capability.
• rest_get_avatar_urls()Retrieves the avatar URLs in various sizes.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• rest_is_field_included()Given an array of fields to include in a response, some of which may be `nested.fields`, determine whether the provided field should be included in the response body.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_REST_Users_Controller::get_fields_for_response()
• WP_REST_Users_Controller::add_additional_fields_to_object()
• WP_REST_Users_Controller::filter_response_by_context()
• WP_REST_Users_Controller::prepare_links()Prepares links for the user request.

Used by · 6

• WP_REST_Users_Controller::create_item()Creates a single user.
• WP_REST_Users_Controller::delete_item()Deletes a single user.
• WP_REST_Users_Controller::get_current_item()Retrieves the current user.
• WP_REST_Users_Controller::get_item()Retrieves a single user.
• WP_REST_Users_Controller::get_items()Retrieves all users.
• WP_REST_Users_Controller::update_item()Updates a single user.

Source

View on Trac ↗View on GitHub ↗

1004	public function prepare_item_for_response( $item, $request ) {1005		// Restores the more descriptive, specific name for use within this method.1006		$user = $item;1007 1008		$fields = $this->get_fields_for_response( $request );1009		$data   = array();1010 1011		if ( in_array( 'id', $fields, true ) ) {1012			$data['id'] = $user->ID;1013		}1014 1015		if ( in_array( 'username', $fields, true ) ) {1016			$data['username'] = $user->user_login;1017		}1018 1019		if ( in_array( 'name', $fields, true ) ) {1020			$data['name'] = $user->display_name;1021		}1022 1023		if ( in_array( 'first_name', $fields, true ) ) {1024			$data['first_name'] = $user->first_name;1025		}1026 1027		if ( in_array( 'last_name', $fields, true ) ) {1028			$data['last_name'] = $user->last_name;1029		}1030 1031		if ( in_array( 'email', $fields, true ) ) {1032			$data['email'] = $user->user_email;1033		}1034 1035		if ( in_array( 'url', $fields, true ) ) {1036			$data['url'] = $user->user_url;1037		}1038 1039		if ( in_array( 'description', $fields, true ) ) {1040			$data['description'] = $user->description;1041		}1042 1043		if ( in_array( 'link', $fields, true ) ) {1044			$data['link'] = get_author_posts_url( $user->ID, $user->user_nicename );1045		}1046 1047		if ( in_array( 'locale', $fields, true ) ) {1048			$data['locale'] = get_user_locale( $user );1049		}1050 1051		if ( in_array( 'nickname', $fields, true ) ) {1052			$data['nickname'] = $user->nickname;1053		}1054 1055		if ( in_array( 'slug', $fields, true ) ) {1056			$data['slug'] = $user->user_nicename;1057		}1058 1059		if ( in_array( 'roles', $fields, true ) && ( current_user_can( 'list_users' ) || current_user_can( 'edit_user', $user->ID ) ) ) {1060			// Defensively call array_values() to ensure an array is returned.1061			$data['roles'] = array_values( $user->roles );1062		}1063 1064		if ( in_array( 'registered_date', $fields, true ) ) {1065			$data['registered_date'] = gmdate( 'c', strtotime( $user->user_registered ) );1066		}1067 1068		if ( in_array( 'capabilities', $fields, true ) ) {1069			$data['capabilities'] = (object) $user->allcaps;1070		}1071 1072		if ( in_array( 'extra_capabilities', $fields, true ) ) {1073			$data['extra_capabilities'] = (object) $user->caps;1074		}1075 1076		if ( in_array( 'avatar_urls', $fields, true ) ) {1077			$data['avatar_urls'] = rest_get_avatar_urls( $user );1078		}1079 1080		if ( in_array( 'meta', $fields, true ) ) {1081			$data['meta'] = $this->meta->get_value( $user->ID, $request );1082		}1083

History

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.