wppaste
WordPress

rest_get_route_for_term( int|WP_Term $term ): string

Since
5.5.0
Source
wp-includes/rest-api.php:3264
Gets the REST API route for a term.

Compatibility

WordPress
since 5.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$termint|WP_Term
Term ID or term object.

Return value

string
The route path with a leading slash for the given term, or an empty string if there is not a route.

Performance profile

How much work a call to rest_get_route_for_term() 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
8–25

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

Plugin surface
1 hook

Third-party callbacks on 'rest_route_for_term' 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

  • querycontent queryget_term()called directly
  • hookthird-party callbacksapply_filters()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 · 3 distinct outcomes

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

WhenInstructionsCalls it makes
!($term instanceof)8get_term()
$term instanceof15get_term(), rest_get_route_for_taxonomy_items()
$term instanceof25get_term(), rest_get_route_for_taxonomy_items(), apply_filters()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev278–252
8.5278–252
8.4278–2522 fewer instructions than PHP 8.3
8.3298–272
8.2298–272
8.1298–272
7.4298–272

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

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

  1. apply_filters( rest_route_for_term )filterline 3286 (+22 into the body)

    Filters the REST API route for a term.

Uses · 3

Used by · 5

Source code

View on Trac View on GitHub 

function rest_get_route_for_term( $term ) {	$term = get_term( $term ); 	if ( ! $term instanceof WP_Term ) {		return '';	} 	$taxonomy_route = rest_get_route_for_taxonomy_items( $term->taxonomy );	if ( ! $taxonomy_route ) {		return '';	} 	$route = sprintf( '%s/%d', $taxonomy_route, $term->term_id ); 	/**	 * Filters the REST API route for a term.	 *	 * @since 5.5.0	 *	 * @param string  $route The route path.	 * @param WP_Term $term  The term object.	 */	return apply_filters( 'rest_route_for_term', $route, $term );}

Changelog

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