rest_get_route_for_post_type_items( string $post_type ): string
Gets the REST API route for a post type.
Parameters
-
$post_type
string Required -
The name of a registered post type.
Return
string The route path with a leading slash for the given post type, or an empty string if there is not a route.
Source
File: wp-includes/rest-api.php
.
View all references
function rest_get_route_for_post_type_items( $post_type ) {
$post_type = get_post_type_object( $post_type );
if ( ! $post_type ) {
return '';
}
if ( ! $post_type->show_in_rest ) {
return '';
}
$namespace = ! empty( $post_type->rest_namespace ) ? $post_type->rest_namespace : 'wp/v2';
$rest_base = ! empty( $post_type->rest_base ) ? $post_type->rest_base : $post_type->name;
$route = sprintf( '/%s/%s', $namespace, $rest_base );
/**
* Filters the REST API route for a post type.
*
* @since 5.9.0
*
* @param string $route The route path.
* @param WP_Post_Type $post_type The post type object.
*/
return apply_filters( 'rest_route_for_post_type_items', $route, $post_type );
}
Hooks
-
apply_filters( 'rest_route_for_post_type_items',
string $route ,WP_Post_Type $post_type ) -
Filters the REST API route for a post type.
Changelog
Version | Description |
---|---|
5.9.0 | Introduced. |