rest_get_queried_resource_route(): string

Return

string

The REST route of the resource, or an empty string if no resource identified.

Hooks fired · 1

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

1. 1
   apply_filters( rest_queried_resource_route )filterline 3310 (+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

View on Trac ↗View on GitHub ↗

3292function rest_get_queried_resource_route() {3293	if ( is_singular() ) {3294		$route = rest_get_route_for_post( get_queried_object() );3295	} elseif ( is_category() || is_tag() || is_tax() ) {3296		$route = rest_get_route_for_term( get_queried_object() );3297	} elseif ( is_author() ) {3298		$route = '/wp/v2/users/' . get_queried_object_id();3299	} else {3300		$route = '';3301	}3302 3303	/**3304	 * Filters the REST route for the currently queried object.3305	 *3306	 * @since 5.5.03307	 *3308	 * @param string $link The route with a leading slash, or an empty string.3309	 */3310	return apply_filters( 'rest_queried_resource_route', $route );3311}

History

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