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

Description

Parameters

$pathstringoptional

REST route. Default empty.Default: ''

$schemestringoptional

Sanitization scheme. Default 'rest'.Default: 'rest'

Return

string

Full URL to the endpoint.

Uses · 1

• get_rest_url()Retrieves the URL to a REST endpoint on a site.

Used by · 50

• WP_REST_Application_Passwords_Controller::prepare_links()Prepares links for the request.
• WP_REST_Attachments_Controller::create_item()Creates a single attachment.
• WP_REST_Attachments_Controller::edit_media_item()Applies edits to a media item and creates a new attachment record.
• WP_REST_Block_Directory_Controller::prepare_links()Generates a list of links to include in the response for the plugin.
• WP_REST_Block_Types_Controller::prepare_links()Prepares links for the request.
• WP_REST_Comments_Controller::create_item()Creates a comment.
• WP_REST_Comments_Controller::get_items()Retrieves a list of comment items.
• WP_REST_Comments_Controller::prepare_links()Prepares links for the request.
• WP_REST_Font_Collections_Controller::get_items()Gets the font collections available.
• WP_REST_Font_Collections_Controller::prepare_links()Prepares links for the request.
• WP_REST_Font_Faces_Controller::prepare_links()Prepares links for the request.
• WP_REST_Font_Families_Controller::prepare_font_face_links()Prepares child font face links for the request.

Source

View on Trac ↗View on GitHub ↗

560function rest_url( $path = '', $scheme = 'rest' ) {561	return get_rest_url( null, $path, $scheme );562}

History

Introduced in 4.4.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.