函数文档

rest_get_url_prefix()

💡 云策文档标注

概述

rest_get_url_prefix() 函数用于获取 WordPress REST API 资源的 URL 前缀。它返回一个字符串,默认值为 'wp-json',并可通过过滤器进行自定义。

关键要点

  • 函数返回 REST API 的 URL 前缀字符串,默认是 'wp-json'。
  • 通过 apply_filters('rest_url_prefix', 'wp-json') 允许开发者使用过滤器修改前缀。
  • 该函数自 WordPress 4.4.0 版本引入,常用于构建 REST 端点 URL。

代码示例

function rest_get_url_prefix() {
    /**
     * Filters the REST URL prefix.
     *
     * @since 4.4.0
     *
     * @param string $prefix URL prefix. Default 'wp-json'.
     */
    return apply_filters( 'rest_url_prefix', 'wp-json' );
}

注意事项

  • 前缀可通过 'rest_url_prefix' 过滤器自定义,例如修改为其他字符串以适应特定需求。
  • 相关函数如 get_rest_url() 依赖此前缀来生成完整的 REST 端点 URL。

📄 原文内容

Retrieves the URL prefix for any API resource.

Return

string Prefix.

Source

function rest_get_url_prefix() {
	/**
	 * Filters the REST URL prefix.
	 *
	 * @since 4.4.0
	 *
	 * @param string $prefix URL prefix. Default 'wp-json'.
	 */
	return apply_filters( 'rest_url_prefix', 'wp-json' );
}

Hooks

apply_filters( ‘rest_url_prefix’, string $prefix )

Filters the REST URL prefix.

Changelog

Version Description
4.4.0 Introduced.