WP_REST_Taxonomies_Controller::prepare_item_for_response( WP_Taxonomy $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_Taxonomy

Taxonomy data.

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response

Response object.

Performance profile

How much work a call to WP_REST_Taxonomies_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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

84–137

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

Plugin surface

1 hook

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

Called by

2

2 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

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Taxonomies_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_Taxonomies_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( rest_prepare_taxonomy )filterline 220 (+7 into the body)

   Filters a taxonomy returned from the REST API.

2. 2
   apply_filters( rest_prepare_taxonomy )filterline 301 (+88 into the body)

   Filters a taxonomy returned from the REST API.

Uses · 8

• apply_filters()Calls the callback functions that have been added to a filter hook.
• 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_Taxonomies_Controller::get_fields_for_response()
• WP_REST_Taxonomies_Controller::add_additional_fields_to_object()
• WP_REST_Taxonomies_Controller::filter_response_by_context()
• WP_REST_Taxonomies_Controller::prepare_links()Prepares links for the request.

Used by · 2

• WP_REST_Taxonomies_Controller::get_item()Retrieves a specific taxonomy.
• WP_REST_Taxonomies_Controller::get_items()Retrieves all public taxonomies.

Source code

View on Trac ↗View on GitHub ↗

213	public function prepare_item_for_response( $item, $request ) {214		// Restores the more descriptive, specific name for use within this method.215		$taxonomy = $item;216 217		// Don't prepare the response body for HEAD requests.218		if ( $request->is_method( 'HEAD' ) ) {219			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php */220			return apply_filters( 'rest_prepare_taxonomy', new WP_REST_Response( array() ), $taxonomy, $request );221		}222 223		$base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;224 225		$fields = $this->get_fields_for_response( $request );226		$data   = array();227 228		if ( in_array( 'name', $fields, true ) ) {229			$data['name'] = $taxonomy->label;230		}231 232		if ( in_array( 'slug', $fields, true ) ) {233			$data['slug'] = $taxonomy->name;234		}235 236		if ( in_array( 'capabilities', $fields, true ) ) {237			$data['capabilities'] = $taxonomy->cap;238		}239 240		if ( in_array( 'description', $fields, true ) ) {241			$data['description'] = $taxonomy->description;242		}243 244		if ( in_array( 'labels', $fields, true ) ) {245			$data['labels'] = $taxonomy->labels;246		}247 248		if ( in_array( 'types', $fields, true ) ) {249			$data['types'] = array_values( $taxonomy->object_type );250		}251 252		if ( in_array( 'show_cloud', $fields, true ) ) {253			$data['show_cloud'] = $taxonomy->show_tagcloud;254		}255 256		if ( in_array( 'hierarchical', $fields, true ) ) {257			$data['hierarchical'] = $taxonomy->hierarchical;258		}259 260		if ( in_array( 'rest_base', $fields, true ) ) {261			$data['rest_base'] = $base;262		}263 264		if ( in_array( 'rest_namespace', $fields, true ) ) {265			$data['rest_namespace'] = $taxonomy->rest_namespace;266		}267 268		if ( in_array( 'visibility', $fields, true ) ) {269			$data['visibility'] = array(270				'public'             => (bool) $taxonomy->public,271				'publicly_queryable' => (bool) $taxonomy->publicly_queryable,272				'show_admin_column'  => (bool) $taxonomy->show_admin_column,273				'show_in_nav_menus'  => (bool) $taxonomy->show_in_nav_menus,274				'show_in_quick_edit' => (bool) $taxonomy->show_in_quick_edit,275				'show_ui'            => (bool) $taxonomy->show_ui,276			);277		}278 279		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';280		$data    = $this->add_additional_fields_to_object( $data, $request );281		$data    = $this->filter_response_by_context( $data, $context );282 283		// Wrap the data in a response object.284		$response = rest_ensure_response( $data );285 286		if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {287			$response->add_links( $this->prepare_links( $taxonomy ) );288		}289 290		/**291		 * Filters a taxonomy returned from the REST API.292		 *

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