WP_REST_Terms_Controller::prepare_item_for_response( WP_Term $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_Term

Term object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response

Response object.

Performance profile

How much work a call to WP_REST_Terms_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_term().

Scaling

Constant

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

Instructions

18–120

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

Plugin surface

1 hook

Third-party callbacks on 'rest_prepare_{$this->taxonomy}' 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_term()one call below WP_REST_Terms_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 · 13 distinct outcomes

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

Hooks and filters fired · 2

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

1. 1
   apply_filters( rest_prepare_{$this->taxonomy} )filterline 906 (+5 into the body)

   Filters the term data for a REST API response.

2. 2
   apply_filters( rest_prepare_{$this->taxonomy} )filterline 976 (+75 into the body)

   Filters the term data for a REST API response.

Uses · 9

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_term_link()Generates a permalink for a taxonomy term archive.
• 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_Terms_Controller::get_fields_for_response()
• WP_REST_Terms_Controller::add_additional_fields_to_object()
• WP_REST_Terms_Controller::filter_response_by_context()
• WP_REST_Terms_Controller::prepare_links()Prepares links for the request.

Used by · 6

• WP_REST_Menus_Controller::prepare_item_for_response()Prepares a single term output for response.
• WP_REST_Terms_Controller::create_item()Creates a single term in a taxonomy.
• WP_REST_Terms_Controller::delete_item()Deletes a single term from a taxonomy.
• WP_REST_Terms_Controller::get_item()Gets a single term from a taxonomy.
• WP_REST_Terms_Controller::get_items()Retrieves terms associated with a taxonomy.
• WP_REST_Terms_Controller::update_item()Updates a single term from a taxonomy.

Source code

View on Trac ↗View on GitHub ↗

901	public function prepare_item_for_response( $item, $request ) {902 903		// Don't prepare the response body for HEAD requests.904		if ( $request->is_method( 'HEAD' ) ) {905			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php */906			return apply_filters( "rest_prepare_{$this->taxonomy}", new WP_REST_Response( array() ), $item, $request );907		}908 909		$fields = $this->get_fields_for_response( $request );910		$data   = array();911 912		if ( in_array( 'id', $fields, true ) ) {913			$data['id'] = (int) $item->term_id;914		}915 916		if ( in_array( 'count', $fields, true ) ) {917			$data['count'] = (int) $item->count;918		}919 920		if ( in_array( 'description', $fields, true ) ) {921			$data['description'] = $item->description;922		}923 924		if ( in_array( 'link', $fields, true ) ) {925			$data['link'] = get_term_link( $item );926		}927 928		if ( in_array( 'name', $fields, true ) ) {929			$data['name'] = $item->name;930		}931 932		if ( in_array( 'slug', $fields, true ) ) {933			$data['slug'] = $item->slug;934		}935 936		if ( in_array( 'taxonomy', $fields, true ) ) {937			$data['taxonomy'] = $item->taxonomy;938		}939 940		if ( in_array( 'parent', $fields, true ) ) {941			$data['parent'] = (int) $item->parent;942		}943 944		if ( in_array( 'meta', $fields, true ) ) {945			$data['meta'] = $this->meta->get_value( $item->term_id, $request );946		}947 948		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';949		$data    = $this->add_additional_fields_to_object( $data, $request );950		$data    = $this->filter_response_by_context( $data, $context );951 952		$response = rest_ensure_response( $data );953 954		if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {955			$response->add_links( $this->prepare_links( $item ) );956		}957 958		/**959		 * Filters the term data for a REST API response.960		 *961		 * The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.962		 *963		 * Possible hook names include:964		 *965		 *  - `rest_prepare_category`966		 *  - `rest_prepare_post_tag`967		 *968		 * Allows modification of the term data right before it is returned.969		 *970		 * @since 4.7.0971		 *972		 * @param WP_REST_Response  $response  The response object.973		 * @param WP_Term           $item      The original term object.974		 * @param WP_REST_Request   $request   Request used to generate the response.975		 */976		return apply_filters( "rest_prepare_{$this->taxonomy}", $response, $item, $request );977	}

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 7.0.4 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-terms-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.