rest_get_route_for_taxonomy_items( string $taxonomy ): string

Compatibility

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

Parameters

$taxonomystring

Name of taxonomy.

Return value

string

The route path with a leading slash for the given taxonomy.

Performance profile

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

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

7–28

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

Plugin surface

1 hook

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

Called by

5

5 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 · 2 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( rest_route_for_taxonomy_items )filterline 3307 (+22 into the body)

   Filters the REST API route for a taxonomy.

Uses · 2

• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 5

• WP_REST_Posts_Controller::prepare_links()Prepares links for the request.
• WP_REST_Taxonomies_Controller::prepare_links()Prepares links for the request.
• WP_REST_Terms_Controller::get_items()Retrieves terms associated with a taxonomy.
• WP_REST_Terms_Controller::prepare_links()Prepares links for the request.
• rest_get_route_for_term()Gets the REST API route for a term.

Source code

View on Trac ↗View on GitHub ↗

3285function rest_get_route_for_taxonomy_items( $taxonomy ) {3286	$taxonomy = get_taxonomy( $taxonomy );3287	if ( ! $taxonomy ) {3288		return '';3289	}3290 3291	if ( ! $taxonomy->show_in_rest ) {3292		return '';3293	}3294 3295	$namespace = ! empty( $taxonomy->rest_namespace ) ? $taxonomy->rest_namespace : 'wp/v2';3296	$rest_base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;3297	$route     = sprintf( '/%s/%s', $namespace, $rest_base );3298 3299	/**3300	 * Filters the REST API route for a taxonomy.3301	 *3302	 * @since 5.9.03303	 *3304	 * @param string      $route    The route path.3305	 * @param WP_Taxonomy $taxonomy The taxonomy object.3306	 */3307	return apply_filters( 'rest_route_for_taxonomy_items', $route, $taxonomy );3308}

Changelog

Introduced in 5.9.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.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.