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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$itemWP_User

User object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response

Response object.

Performance profile

How much work a call to WP_REST_Users_Controller::prepare_item_for_response() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_user_by().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

101–163

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 213.

Plugin surface

1 hook

Third-party callbacks on 'rest_prepare_user' run inside this call, and their cost is not bounded by anything here.

Called by

6

6 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_user_by()one call below WP_REST_Users_Controller::prepare_item_for_response()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 192 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Users_Controller::prepare_item_for_response() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 2

2 hooks fire while WP_REST_Users_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( rest_prepare_user )filterline 1041 (+7 into the body)

   Filters user data returned from the REST API.

2. 2
   apply_filters( rest_prepare_user )filterline 1141 (+107 into the body)

   Filters user data returned from the REST API.

Uses · 12

• apply_filters()Calls the callback functions that have been added to a filter hook.
• 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.
• WP_REST_Response::__construct()
• 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 code

View on Trac ↗View on GitHub ↗

1034	public function prepare_item_for_response( $item, $request ) {1035		// Restores the more descriptive, specific name for use within this method.1036		$user = $item;1037 1038		// Don't prepare the response body for HEAD requests.1039		if ( $request->is_method( 'HEAD' ) ) {1040			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php */1041			return apply_filters( 'rest_prepare_user', new WP_REST_Response( array() ), $user, $request );1042		}1043 1044		$fields = $this->get_fields_for_response( $request );1045		$data   = array();1046 1047		if ( in_array( 'id', $fields, true ) ) {1048			$data['id'] = $user->ID;1049		}1050 1051		if ( in_array( 'username', $fields, true ) ) {1052			$data['username'] = $user->user_login;1053		}1054 1055		if ( in_array( 'name', $fields, true ) ) {1056			$data['name'] = $user->display_name;1057		}1058 1059		if ( in_array( 'first_name', $fields, true ) ) {1060			$data['first_name'] = $user->first_name;1061		}1062 1063		if ( in_array( 'last_name', $fields, true ) ) {1064			$data['last_name'] = $user->last_name;1065		}1066 1067		if ( in_array( 'email', $fields, true ) ) {1068			$data['email'] = $user->user_email;1069		}1070 1071		if ( in_array( 'url', $fields, true ) ) {1072			$data['url'] = $user->user_url;1073		}1074 1075		if ( in_array( 'description', $fields, true ) ) {1076			$data['description'] = $user->description;1077		}1078 1079		if ( in_array( 'link', $fields, true ) ) {1080			$data['link'] = get_author_posts_url( $user->ID, $user->user_nicename );1081		}1082 1083		if ( in_array( 'locale', $fields, true ) ) {1084			$data['locale'] = get_user_locale( $user );1085		}1086 1087		if ( in_array( 'nickname', $fields, true ) ) {1088			$data['nickname'] = $user->nickname;1089		}1090 1091		if ( in_array( 'slug', $fields, true ) ) {1092			$data['slug'] = $user->user_nicename;1093		}1094 1095		if ( in_array( 'roles', $fields, true ) && ( current_user_can( 'list_users' ) || current_user_can( 'edit_user', $user->ID ) ) ) {1096			// Defensively call array_values() to ensure an array is returned.1097			$data['roles'] = array_values( $user->roles );1098		}1099 1100		if ( in_array( 'registered_date', $fields, true ) ) {1101			$data['registered_date'] = gmdate( 'c', strtotime( $user->user_registered ) );1102		}1103 1104		if ( in_array( 'capabilities', $fields, true ) ) {1105			$data['capabilities'] = (object) $user->allcaps;1106		}1107 1108		if ( in_array( 'extra_capabilities', $fields, true ) ) {1109			$data['extra_capabilities'] = (object) $user->caps;1110		}1111 1112		if ( in_array( 'avatar_urls', $fields, true ) ) {1113			$data['avatar_urls'] = rest_get_avatar_urls( $user );

Changelog

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.8.8 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.