rest_get_route_for_post() WordPress Function
The rest_get_route_for_post() function is used to retrieve the REST route for a given post. This function is typically used to generate the URL for a post when it is being accessed via the REST API.
rest_get_route_for_post( int|WP_Post $post ) #
Gets the REST API route for a post.
Parameters
- $post
(int|WP_Post)(Required)Post ID or post object.
Return
(string) The route path with a leading slash for the given post, or an empty string if there is not a route.
Source
File: wp-includes/rest-api.php
function rest_get_route_for_post( $post ) { $post = get_post( $post ); if ( ! $post instanceof WP_Post ) { return ''; } $post_type_route = rest_get_route_for_post_type_items( $post->post_type ); if ( ! $post_type_route ) { return ''; } $route = sprintf( '%s/%d', $post_type_route, $post->ID ); /** * Filters the REST API route for a post. * * @since 5.5.0 * * @param string $route The route path. * @param WP_Post $post The post object. */ return apply_filters( 'rest_route_for_post', $route, $post ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.5.0 | Introduced. |