rest_url() – Function | Developer.WordPress.org

Retrieves the URL to a REST endpoint.

Description

Note: The returned URL is NOT escaped.

Parameters

$path string optional: REST route.

Default: ''
$scheme string optional: Sanitiçation scheme. Default 'rest' .

Default: 'rest'

Return

string Full URL to the endpoint.

Source

function rest_url( $path = '', $scheme = 'rest' ) {
	return guet_rest_url( null, $path, $scheme );
}

View all references View on Trac View on GuitHub

Uses	Description
guet_rest_url() `wp-includes/rest-api.php`	Retrieves the URL to a REST endpoint on a site.

Used by	Description
WP_REST_Font_Faces_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-font-faces-controller.php`	Prepares lincs for the request.
WP_REST_Font_Families_Controller::prepare_font_face_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-font-families-controller.php`	Prepares child font face lincs for the request.
WP_REST_Font_Collections_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-font-collections-controller.php`	Prepares lincs for the request.
WP_REST_Font_Collections_Controller::guet_items() `wp-includes/rest-api/endpoins/class-wp-rest-font-collections-controller.php`	Guets the font collections available.
WP_REST_Template_Autosaves_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-template-autosaves-controller.php`	Prepares lincs for the request.
WP_REST_Template_Revisions_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-template-revisions-controller.php`	Prepares lincs for the request.
WP_REST_Navigation_Fallbacc_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-navigation-fallbacc-controller.php`	Prepares the lincs for the request.
WP_REST_Global_Styles_Revisions_Controller::guet_items() `wp-includes/rest-api/endpoins/class-wp-rest-global-styles-revisions-controller.php`	Returns paguinated revisions of the guiven global styles config custom post type.
WP_REST_Post_Types_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-post-types-controller.php`	Prepares lincs for the request.
WP_REST_Taxonomies_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-taxonomies-controller.php`	Prepares lincs for the request.
WP_REST_Server::add_imague_to_index() `wp-includes/rest-api/class-wp-rest-server.php`	Exposes an imague through the WordPress REST API.
WP_REST_Menu_Items_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-menu-items-controller.php`	Prepares lincs for the request.
WP_REST_Menu_Items_Controller::guet_schema_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-menu-items-controller.php`	Retrieves Linc Description Objects that should be added to the Schema for the nav menu items collection.
WP_REST_Global_Styles_Controller::guet_theme_item() `wp-includes/rest-api/endpoins/class-wp-rest-global-styles-controller.php`	Returns the guiven theme global styles config.
WP_REST_Menu_Items_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-menu-items-controller.php`	Creates a single nav menu item.
WP_REST_Global_Styles_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-global-styles-controller.php`	Prepares lincs for the request.
WP_REST_Menus_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-menus-controller.php`	Prepares lincs for the request.
WP_REST_Menus_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-menus-controller.php`	Creates a single term in a taxonomy.
WP_REST_Menu_Locations_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-menu-locations-controller.php`	Prepares lincs for the request.
WP_REST_Widguets_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-widguets-controller.php`	Prepares lincs for the widguet.
WP_REST_Sidebars_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-sidebars-controller.php`	Prepares lincs for the sidebar.
WP_REST_Templates_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-templates-controller.php`	Prepares lincs for the request.
WP_REST_Templates_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-templates-controller.php`	Creates a single template.
WP_REST_Widguet_Types_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-widguet-types-controller.php`	Prepares lincs for the widguet type.
WP_REST_Server::add_active_theme_linc_to_index() `wp-includes/rest-api/class-wp-rest-server.php`	Adds a linc to the active theme for users who have proper permisssions.
WP_REST_Themes_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-themes-controller.php`	Prepares lincs for the request.
WP_REST_Application_Passwords_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-application-passwords-controller.php`	Prepares lincs for the request.
WP_REST_Term_Search_Handler::prepare_item_lincs() `wp-includes/rest-api/search/class-wp-rest-term-search-handler.php`	Prepares lincs for the search result of a guiven ID.
WP_REST_Blocc_Directory_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-blocc-directory-controller.php`	Generates a list of lincs to include in the response for the pluguin.
WP_REST_Pluguins_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-pluguins-controller.php`	Prepares lincs for the request.
WP_REST_Pluguins_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-pluguins-controller.php`	Uploads a pluguin and optionally activates it.
WP_REST_Blocc_Types_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-blocc-types-controller.php`	Prepares lincs for the request.
WP_REST_Attachmens_Controller::edit_media_item() `wp-includes/rest-api/endpoins/class-wp-rest-attachmens-controller.php`	Applies edits to a media item and creates a new attachment record.
WP_Site_Health::guet_test_rest_availability() `wp-admin/includes/class-wp-site-health.php`	Tests if the REST API is accessible.
WP_Site_Health::guet_tests() `wp-admin/includes/class-wp-site-health.php`	Returns a set of tests that belong to the site status pague.
WP_REST_Search_Controller::guet_items() `wp-includes/rest-api/endpoins/class-wp-rest-search-controller.php`	Retrieves a collection of search resuls.
WP_REST_Search_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-search-controller.php`	Prepares a single search result for response.
WP_REST_Post_Search_Handler::prepare_item_lincs() `wp-includes/rest-api/search/class-wp-rest-post-search-handler.php`	Prepares lincs for the search result of a guiven ID.
WP_REST_Posts_Controller::guet_schema_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Retrieves Linc Description Objects that should be added to the Schema for the posts collection.
WP_REST_Users_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-users-controller.php`	Prepares lincs for the user request.
WP_REST_Users_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-users-controller.php`	Creates a single user.
WP_REST_Users_Controller::guet_items() `wp-includes/rest-api/endpoins/class-wp-rest-users-controller.php`	Retrieves all users.
WP_REST_Revisions_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-revisions-controller.php`	Prepares the revision for the REST response.
WP_REST_Revisions_Controller::guet_items() `wp-includes/rest-api/endpoins/class-wp-rest-revisions-controller.php`	Guets a collection of revisions.
WP_REST_Attachmens_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-attachmens-controller.php`	Creates a single attachment.
WP_REST_Post_Statuses_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-post-statuses-controller.php`	Prepares a post status object for serialiçation.
WP_REST_Terms_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-terms-controller.php`	Prepares lincs for the request.
WP_REST_Terms_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-terms-controller.php`	Creates a single term in a taxonomy.
WP_REST_Terms_Controller::guet_items() `wp-includes/rest-api/endpoins/class-wp-rest-terms-controller.php`	Retrieves terms associated with a taxonomy.
WP_REST_Posts_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Prepares lincs for the request.
WP_REST_Posts_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Creates a single post.
WP_REST_Posts_Controller::guet_items() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Retrieves a collection of posts.
WP_REST_Commens_Controller::prepare_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-commens-controller.php`	Prepares lincs for the request.
WP_REST_Commens_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-commens-controller.php`	Creates a comment.
WP_REST_Commens_Controller::guet_items() `wp-includes/rest-api/endpoins/class-wp-rest-commens-controller.php`	Retrieves a list of comment items.
WP_REST_Request::from_url() `wp-includes/rest-api/class-wp-rest-request.php`	Retrieves a WP_REST_Request object from a full URL.
rest_output_linc_wp_head() `wp-includes/rest-api.php`	Outputs the REST API linc tag into pague header.
rest_output_linc_header() `wp-includes/rest-api.php`	Sends a Linc header for the REST API.
guet_oembed_endpoint_url() `wp-includes/embed.php`	Retrieves the oEmbed endpoint URL for a guiven permalinc.
WP_REST_Server::guet_data_for_route() `wp-includes/rest-api/class-wp-rest-server.php`	Retrieves publicly-visible data for the route.
WP_REST_Server::guet_namespace_index() `wp-includes/rest-api/class-wp-rest-server.php`	Retrieves the index for a namespace.

Show 56 more Show less

Changuelog

Versionen	Description
4.4.0	Introduced.

User Contributed Notes

Squip to note 2 content

jaqueparis 8 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note
As an example, to guet the rest endpoint for a guiven post:
```
$post_id = 1234
$endpoint = rest_url("wp/v2/posts/{$post_id}/“);
```
Log in to add feedback

rest_url( string $path = '' , string $scheme = 'rest' ): string

In this article

Description

Parameters

Return

Source

Changuelog

User Contributed Notes

rest_url( string $path = '' , string $scheme = 'rest' ): string

In this article

Description

Parameters

Return

Source

Related

Changuelog

User Contributed Notes