WP_REST_Terms_Controller::get_items( WP_REST_Request $request ): WP_REST_Response|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Performance profile

How much work a call to WP_REST_Terms_Controller::get_items() 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 wp_get_object_terms().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

113–178

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

Plugin surface

1 hook

Third-party callbacks on 'rest_{$this->taxonomy}_query' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent querywp_get_object_terms()called directly

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 · 24 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Terms_Controller::get_items() 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 · 1

One hook fires while WP_REST_Terms_Controller::get_items() runs, in this order:

1. 1
   apply_filters( rest_{$this->taxonomy}_query )filterline 343 (+108 into the body)

   Filters get_terms() arguments when querying terms via the REST API.

Uses · 15

• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.
• get_terms()Retrieves the terms in a given taxonomy or list of taxonomies.
• wp_count_terms()Counts how many terms are in taxonomy.
• current_user_can()Returns whether the current user has the specified capability.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• rest_url()Retrieves the URL to a REST endpoint.
• rest_get_route_for_taxonomy_items()Gets the REST API route for a taxonomy.
• add_query_arg()Retrieves a modified URL query string.
• urlencode_deep()Navigates through an array, object, or scalar, and encodes the values to be used in a URL.
• WP_REST_Terms_Controller::get_collection_params()Retrieves the query params for collections.

Source code

View on Trac ↗View on GitHub ↗

235	public function get_items( $request ) {236 237		// Retrieve the list of registered collection query parameters.238		$registered = $this->get_collection_params();239 240		/*241		 * This array defines mappings between public API query parameters whose242		 * values are accepted as-passed, and their internal WP_Query parameter243		 * name equivalents (some are the same). Only values which are also244		 * present in $registered will be set.245		 */246		$parameter_mappings = array(247			'exclude'    => 'exclude',248			'include'    => 'include',249			'order'      => 'order',250			'orderby'    => 'orderby',251			'post'       => 'post',252			'hide_empty' => 'hide_empty',253			'per_page'   => 'number',254			'search'     => 'search',255			'slug'       => 'slug',256		);257 258		$prepared_args = array( 'taxonomy' => $this->taxonomy );259 260		/*261		 * For each known parameter which is both registered and present in the request,262		 * set the parameter's value on the query $prepared_args.263		 */264		foreach ( $parameter_mappings as $api_param => $wp_param ) {265			if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {266				$prepared_args[ $wp_param ] = $request[ $api_param ];267			}268		}269 270		if ( isset( $prepared_args['orderby'] ) && isset( $request['orderby'] ) ) {271			$orderby_mappings = array(272				'include_slugs' => 'slug__in',273			);274 275			if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) {276				$prepared_args['orderby'] = $orderby_mappings[ $request['orderby'] ];277			}278		}279 280		if ( isset( $registered['offset'] ) && ! empty( $request['offset'] ) ) {281			$prepared_args['offset'] = $request['offset'];282		} else {283			$prepared_args['offset'] = ( $request['page'] - 1 ) * $prepared_args['number'];284		}285 286		$taxonomy_obj = get_taxonomy( $this->taxonomy );287 288		if ( $taxonomy_obj->hierarchical && isset( $registered['parent'], $request['parent'] ) ) {289			if ( 0 === $request['parent'] ) {290				// Only query top-level terms.291				$prepared_args['parent'] = 0;292			} else {293				if ( $request['parent'] ) {294					$prepared_args['parent'] = $request['parent'];295				}296			}297		}298 299		/*300		 * When a taxonomy is registered with an 'args' array,301		 * those params override the `$args` passed to this function.302		 *303		 * We only need to do this if no `post` argument is provided.304		 * Otherwise, terms will be fetched using `wp_get_object_terms()`,305		 * which respects the default query arguments set for the taxonomy.306		 */307		if (308			empty( $prepared_args['post'] ) &&309			isset( $taxonomy_obj->args ) &&310			is_array( $taxonomy_obj->args )311		) {312			$prepared_args = array_merge( $prepared_args, $taxonomy_obj->args );313		}314

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.