get_rest_url()

💡 云策文档标注

概述

get_rest_url() 函数用于获取站点上 REST 端点的完整 URL。它支持多站点环境，并处理不同的固定链接设置，返回的 URL 未经过转义。

关键要点

函数返回 REST 端点的完整 URL，适用于 WordPress REST API 开发。
参数包括可选的 $blog_id（博客 ID）、$path（REST 路由）和 $scheme（净化方案），默认值分别为 null、'/' 和 'rest'。
内部逻辑根据是否启用固定链接和多站点设置，动态构建 URL，并考虑 SSL 和管理员强制 HTTPS 情况。
通过 'rest_url' 过滤器允许自定义返回的 URL。

代码示例

$endpoint = get_rest_url(null, 'wp/v2/posts');
get_rest_url(); // 返回 https://example.com/wp-json/
get_rest_url(null, 'wp/v2/search'); // 返回 https://example.com/wp-json/wp/v2/search

注意事项

返回的 URL 未经过转义，使用时需注意安全处理。
在 JavaScript 中，可通过查询 link 标签的 href 属性获取 REST 端点，例如：var endpoint = document.querySelector('link[rel="https://api.w.org/"]').href;

📄 原文内容

Retrieves the URL to a REST endpoint on a site.

Description

Note: The returned URL is NOT escaped.

Parameters

$blog_idint|nulloptional: Blog ID. Default of null returns URL for current blog.

Default:null
$pathstringoptional: REST route. Default '/'.
$schemestringoptional: Sanitization scheme. Default 'rest'.

Return

string Full URL to the endpoint.

Source

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 );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘rest_url’, string $url, string $path, int|null $blog_id, string $scheme ): Filters the REST URL.

Uses	Description
rest_get_url_prefix()`wp-includes/rest-api.php`	Retrieves the URL prefix for any API resource.
is_ssl()`wp-includes/load.php`	Determines if SSL is used.
force_ssl_admin()`wp-includes/functions.php`	Determines whether to force SSL used for the Administration Screens.
set_url_scheme()`wp-includes/link-template.php`	Sets the scheme for a URL.
get_home_url()`wp-includes/link-template.php`	Retrieves the URL for a given site where the front end is accessible.
WP_Rewrite::using_index_permalinks()`wp-includes/class-wp-rewrite.php`	Determines whether permalinks are being used and rewrite module is not enabled.
get_blog_option()`wp-includes/ms-blogs.php`	Retrieves option value for a given blog id based on name of option.
trailingslashit()`wp-includes/formatting.php`	Appends a trailing slash.
is_multisite()`wp-includes/load.php`	Determines whether Multisite is enabled.
is_admin()`wp-includes/load.php`	Determines whether the current request is for an administrative interface page.
add_query_arg()`wp-includes/functions.php`	Retrieves a modified URL query string.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.

Show 8 more Show less

Used by	Description
wp_is_local_html_output()`wp-includes/https-detection.php`	Checks whether a given HTML string is likely an output from this WordPress site.
wp_default_packages_inline_scripts()`wp-includes/script-loader.php`	Adds inline scripts required for the WordPress JavaScript packages.
rest_output_rsd()`wp-includes/rest-api.php`	Adds the REST API URL to the WP RSD endpoint.
rest_output_link_wp_head()`wp-includes/rest-api.php`	Outputs the REST API link tag into page header.
rest_output_link_header()`wp-includes/rest-api.php`	Sends a Link header for the REST API.
rest_url()`wp-includes/rest-api.php`	Retrieves the URL to a REST endpoint.
WP_REST_Server::serve_request()`wp-includes/rest-api/class-wp-rest-server.php`	Handles serving a REST API request.
wp_default_scripts()`wp-includes/script-loader.php`	Registers all WordPress scripts.

Show 3 more Show less

Changelog

Version	Description
4.4.0	Introduced.

User Contributed Notes

Skip to note 4 content

Jerome

6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note
Relevant information: 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="<a href="https://api.w.org/"%5D" rel="nofollow ugc">https://api.w.org/"%5D</a>').href;
```
That code will extract the endpoint from the tag:
```
<link rel="<a href="https://api.w.org/&quot" rel="nofollow ugc">https://api.w.org/"</a>; href="<a href="https://example.com/wp-json/&quot" rel="nofollow ugc">https://example.com/wp-json/"</a>; />
```
Log in to add feedback
Skip to note 5 content

Khoi Pro

7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Example:
```
$endpoint = get_rest_url(null, 'wp/v2/posts');
```
Log in to add feedback

Skip to note 6 content

Jerome

6 years ago

get_rest_url(); // <a href="https://example.com/wp-json/" rel="nofollow ugc">https://example.com/wp-json/</a>
get_rest_url( null, 'wp/v2/search' ); // <a href="https://example.com/wp-json/wp/v2/search" rel="nofollow ugc">https://example.com/wp-json/wp/v2/search</a>

云策 WordPress 开发者社区

函数文档