rest_get_route_for_taxonomy_items() WordPress Function
The rest_get_route_for_taxonomy_items() function is used to get the REST route for a taxonomy term. It takes two arguments: the taxonomy name and the term name. This function is useful for registering custom routes for taxonomies. For example, if you have a custom taxonomy called "fruit", you can use this function to get the route for "fruit" terms.
rest_get_route_for_taxonomy_items( string $taxonomy ) #
Gets the REST API route for a taxonomy.
Parameters
- $taxonomy
(string)(Required)Name of taxonomy.
Return
(string) The route path with a leading slash for the given taxonomy.
Source
File: wp-includes/rest-api.php
function rest_get_route_for_taxonomy_items( $taxonomy ) {
$taxonomy = get_taxonomy( $taxonomy );
if ( ! $taxonomy ) {
return '';
}
if ( ! $taxonomy->show_in_rest ) {
return '';
}
$namespace = ! empty( $taxonomy->rest_namespace ) ? $taxonomy->rest_namespace : 'wp/v2';
$rest_base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
$route = sprintf( '/%s/%s', $namespace, $rest_base );
/**
* Filters the REST API route for a taxonomy.
*
* @since 5.9.0
*
* @param string $route The route path.
* @param WP_Taxonomy $taxonomy The taxonomy object.
*/
return apply_filters( 'rest_route_for_taxonomy_items', $route, $taxonomy );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.9.0 | Introduced. |