rest_get_queried_resource_route(): string
- Since
- 5.5.0
- Source
wp-includes/rest-api.php:3325
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.
Return value
string- The REST route of the resource, or an empty string if no resource identified.
Performance profile
How much work a call to rest_get_queried_resource_route() 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
- Scaling
- Constant
- Instructions
- 15–24
- Plugin surface
- 1 hook
- Called by
- 2
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 39.
Third-party callbacks on 'rest_queried_resource_route' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below rest_get_queried_resource_route()
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 · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_get_queried_resource_route() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_singular() | 15 | is_singular(), get_queried_object(), rest_get_route_for_post(), apply_filters() |
!is_singular() && is_category() | 18 | is_singular(), is_category(), get_queried_object(), rest_get_route_for_term(), apply_filters() |
!is_singular() && !is_category() && is_tag() | 21 | is_singular(), is_category(), is_tag(), get_queried_object(), rest_get_route_for_term(), apply_filters() |
!is_singular() && !is_category() && !is_tag() && !is_tax() && !is_author() | 21 | is_singular(), is_category(), is_tag(), is_tax(), is_author(), apply_filters() |
!is_singular() && !is_category() && !is_tag() && !is_tax() && is_author() | 24 | is_singular(), is_category(), is_tag(), is_tax(), is_author(), get_queried_object_id(), apply_filters() |
!is_singular() && !is_category() && !is_tag() && is_tax() | 24 | is_singular(), is_category(), is_tag(), is_tax(), get_queried_object(), rest_get_route_for_term(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 39 instructions, 15–24 executed per call, 5 branches. The work does not change between versions.
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_queried_resource_route() runs, in this order:
- apply_filters( rest_queried_resource_route )filterline 3343 (+18 into the body)
Filters the REST route for the currently queried object.
Uses · 10
- is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
- rest_get_route_for_post()Gets the REST API route for a post.
- get_queried_object()Retrieves the currently queried object.
- is_category()Determines whether the query is for an existing category archive page.
- is_tag()Determines whether the query is for an existing tag archive page.
- is_tax()Determines whether the query is for an existing custom taxonomy archive page.
- rest_get_route_for_term()Gets the REST API route for a term.
- is_author()Determines whether the query is for an existing author archive page.
- get_queried_object_id()Retrieves the ID of the currently queried object.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 2
- rest_output_link_header()Sends a Link header for the REST API.
- rest_output_link_wp_head()Outputs the REST API link tag into page header.
Source code
function rest_get_queried_resource_route() { if ( is_singular() ) { $route = rest_get_route_for_post( get_queried_object() ); } elseif ( is_category() || is_tag() || is_tax() ) { $route = rest_get_route_for_term( get_queried_object() ); } elseif ( is_author() ) { $route = '/wp/v2/users/' . get_queried_object_id(); } else { $route = ''; } /** * Filters the REST route for the currently queried object. * * @since 5.5.0 * * @param string $link The route with a leading slash, or an empty string. */ return apply_filters( 'rest_queried_resource_route', $route );}Changelog
Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 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.