get_rest_url() │ WP 4.4.0

Gets the URL of the REST API endpoint. Allows specifying the site of the network.

The returned URL is not sanitized for output. Therefore, use the function esc_url() before outputting.

Uses: get_home_url(), rest_get_url_prefix()

Used By: rest_url(), rest_output_link_wp_head()

1 time — 0.000043 sec (very fast) | 50000 times — 0.82 sec (very fast) | PHP 7.0.5, WP 4.4.2

Hooks from the function

rest_url

Returns

String. URL to the REST API endpoint.

Usage

get_rest_url( $blog_id, $path, $scheme );

$blog_id(integer): ID of the site/blog. Passed to get_home_url()
Default: null (current site)
$path(string): REST route (path). Added to the end of the URL, the last slash is removed if present.
Default: '/'
$scheme(string): Data cleaning scheme. Passed to get_home_url().
Default: 'rest'

Examples

#1 Demo: Get the URLs of REST endpoints

Get the URLs of the different REST endpoints:

echo get_rest_url();
//> http://example.com/wp-json/

echo get_rest_url( 5 );
//> http://subsite.example.com/wp-json/

echo get_rest_url( null, '/foo' );
//> http://example.com/wp-json/foo

echo get_rest_url( null, '/foo', 'https' );
//> https://example.com/wp-json/foo

#2 Get the REST endpoint for JS code

If you’re using the REST API, you’re most likely using JavaScript.

You can get the REST endpoint for a site by getting the href attribute of a <link> tag WordPress adds to the <head> tag of your site:

var endpoint = document.querySelector( 'link[rel="https://api.w.org/"]' ).href;

That code will extract the endpoint from the tag:

<link rel="https://api.w.org/" href="https://example.com/wp-json/" />

Notes

Global. WP_Rewrite. $wp_rewrite WordPress rewrite component.

Changelog

Since 4.4.0

Introduced.

`get_rest_url() get rest url` code ^{WP 6.8.3}

wp-includes/rest-api.php

function get_rest_url( $blog_id = null, $path = '/', $scheme = 'rest' ) {
	if ( empty( $path ) ) {
		$path = '/';
	}

	$path = '/' . ltrim( $path, '/' );

	if ( is_multisite() && get_blog_option( $blog_id, 'permalink_structure' ) || get_option( 'permalink_structure' ) ) {
		global $wp_rewrite;

		if ( $wp_rewrite->using_index_permalinks() ) {
			$url = get_home_url( $blog_id, $wp_rewrite->index . '/' . rest_get_url_prefix(), $scheme );
		} else {
			$url = get_home_url( $blog_id, rest_get_url_prefix(), $scheme );
		}

		$url .= $path;
	} else {
		$url = trailingslashit( get_home_url( $blog_id, '', $scheme ) );
		/*
		 * nginx only allows HTTP/1.0 methods when redirecting from / to /index.php.
		 * To work around this, we manually add index.php to the URL, avoiding the redirect.
		 */
		if ( ! str_ends_with( $url, 'index.php' ) ) {
			$url .= 'index.php';
		}

		$url = add_query_arg( 'rest_route', $path, $url );
	}

	if ( is_ssl() && isset( $_SERVER['SERVER_NAME'] ) ) {
		// If the current host is the same as the REST URL host, force the REST URL scheme to HTTPS.
		if ( parse_url( get_home_url( $blog_id ), PHP_URL_HOST ) === $_SERVER['SERVER_NAME'] ) {
			$url = set_url_scheme( $url, 'https' );
		}
	}

	if ( is_admin() && force_ssl_admin() ) {
		/*
		 * In this situation the home URL may be http:, and `is_ssl()` may be false,
		 * but the admin is served over https: (one way or another), so REST API usage
		 * will be blocked by browsers unless it is also served over HTTPS.
		 */
		$url = set_url_scheme( $url, 'https' );
	}

	/**
	 * Filters the REST URL.
	 *
	 * Use this filter to adjust the url returned by the get_rest_url() function.
	 *
	 * @since 4.4.0
	 *
	 * @param string   $url     REST URL.
	 * @param string   $path    REST route.
	 * @param int|null $blog_id Blog ID.
	 * @param string   $scheme  Sanitization scheme.
	 */
	return apply_filters( 'rest_url', $url, $path, $blog_id, $scheme );
}