阐述 WordPress `get_rest_url()` 函数的源码：生成 REST API 基础 URL 的工作原理。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，晚上好！我是你们的老朋友，bug 终结者（希望是）。今天咱们来聊聊 WordPress 里的一个看似简单，但又暗藏玄机的函数：get_rest_url()。这玩意儿就像 REST API 的指路明灯，告诉你 API 的大本营在哪儿。咱们一起来扒一扒它的底裤，看看它到底是怎么工作的。

开场白：REST API 的重要性

在深入代码之前，咱们先简单回顾一下 REST API 的重要性。想象一下，你的 WordPress 网站想要跟手机 APP、第三方服务、或者甚至未来来自火星的浏览器进行数据交互，怎么办？靠写一堆乱七八糟的自定义代码？那维护起来简直就是噩梦。

这时候 REST API 就闪亮登场了。它提供了一套标准化的接口，让不同的系统能够用统一的方式进行数据交换。WordPress 从 4.4 版本开始正式引入 REST API，让网站的数据不再局限于 WordPress 的领地，而是可以自由地翱翔在互联网的天空中。

而 get_rest_url() 函数，就是打开这扇大门的钥匙。

get_rest_url() 函数：API 的 GPS 定位器

get_rest_url() 函数，顾名思义，就是用来获取 REST API 的基本 URL 的。简单来说，它会返回一个字符串，指向你 WordPress 网站的 REST API 入口。有了这个入口，你才能进一步访问各种 API 接口，比如获取文章列表、创建用户等等。

源码解析：一层一层剥开它的心

好了，废话不多说，咱们直接上代码！get_rest_url() 函数的定义可以在 wp-includes/rest-api.php 文件中找到。我们来简化一下，提取出核心逻辑：

function get_rest_url( $blog_id = null, $path = '/' ) {
    global $wp_rewrite;

    if ( ! isset( $blog_id ) ) {
        $blog_id = get_current_blog_id();
    }

    $url = get_home_url( $blog_id );

    if ( ! $wp_rewrite->using_permalinks() ) {
        $url .= '/?rest_route=' . $path;
        return $url;
    }

    if ( get_option( 'use_nginx_for_rest_api' ) && defined( 'WP_REST_API_URI' ) ) {
        $url = WP_REST_API_URI;
    } else {
        $rest_prefix = trailingslashit( rest_get_url_prefix() );
        $url         = trailingslashit( $url ) . $rest_prefix . ltrim( $path, '/' );
    }

    return $url;
}

看起来有点复杂，但别怕，咱们一行一行地解释：

function get_rest_url( $blog_id = null, $path = '/' ): 这是函数的定义。
- $blog_id：可选参数，指定博客 ID。如果为空，则使用当前博客 ID。这在多站点环境下很有用。
- $path：可选参数，指定 API 路径。默认为根路径 '/'。
global $wp_rewrite;: 引入全局的 $wp_rewrite 对象。这个对象负责处理 WordPress 的固定链接。
if ( ! isset( $blog_id ) ) { $blog_id = get_current_blog_id(); }: 如果 $blog_id 没有指定，就获取当前博客的 ID。
$url = get_home_url( $blog_id );: 获取博客的首页 URL。这是 REST API URL 的基础。get_home_url() 函数会返回类似 https://example.com 这样的 URL。
if ( ! $wp_rewrite->using_permalinks() ) { ... }: 判断是否启用了固定链接。如果没有启用固定链接（也就是使用了丑陋的 ?p=123 这样的 URL），那么 REST API 的 URL 会附加 ?rest_route=$path。
- $url .= '/?rest_route=' . $path;: 将 /?rest_route=$path 附加到 URL 后面。
- return $url;: 直接返回 URL。
if ( get_option( 'use_nginx_for_rest_api' ) && defined( 'WP_REST_API_URI' ) ) { ... }: 判断是否使用了 Nginx，并且定义了 WP_REST_API_URI 常量。这通常用于配置 Nginx 来处理 REST API 请求。
- $url = WP_REST_API_URI;: 如果使用了 Nginx 配置，则直接使用 WP_REST_API_URI 常量作为 REST API 的 URL。
else { ... }: 如果没有使用 Nginx 配置，则使用 WordPress 默认的方式来生成 REST API 的 URL。
- $rest_prefix = trailingslashit( rest_get_url_prefix() );: 获取 REST API 的 URL 前缀，例如 'wp-json/'。rest_get_url_prefix() 函数返回前缀，trailingslashit() 函数确保前缀以斜杠结尾。
- $url = trailingslashit( $url ) . $rest_prefix . ltrim( $path, '/' );: 将首页 URL、REST API 前缀和路径拼接起来，生成最终的 REST API URL。trailingslashit() 函数确保首页 URL 以斜杠结尾，ltrim( $path, '/' ) 函数移除路径开头的斜杠。
return $url;: 返回最终的 REST API URL。

代码示例：实际应用

光说不练假把式，咱们来几个实际的例子：

获取默认的 REST API URL：

$rest_url = get_rest_url();
echo $rest_url; // 输出：https://example.com/wp-json/

获取指定路径的 REST API URL：

$rest_url = get_rest_url( null, '/wp/v2/posts' );
echo $rest_url; // 输出：https://example.com/wp-json/wp/v2/posts

在多站点环境下，获取指定博客的 REST API URL：

$blog_id = 2; // 博客 ID
$rest_url = get_rest_url( $blog_id );
echo $rest_url; // 输出：https://example.com/blog2/wp-json/ (假设 blog2 是子站点的目录)

深入挖掘：rest_get_url_prefix() 函数

刚才提到了 rest_get_url_prefix() 函数，它负责返回 REST API 的 URL 前缀。咱们也来看看它的源码（也在 wp-includes/rest-api.php 文件中）：

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

这个函数很简单，就是返回 'wp-json' 这个字符串。但是，它使用了 apply_filters() 函数，这意味着你可以通过 WordPress 的过滤器来修改 REST API 的 URL 前缀。这在某些特殊情况下很有用，比如你需要隐藏 REST API 的存在，或者与现有的 URL 结构冲突。

使用过滤器修改 REST API URL 前缀：

add_filter( 'rest_url_prefix', 'my_custom_rest_prefix' );

function my_custom_rest_prefix( $prefix ) {
    return 'api';
}

// 现在，get_rest_url() 函数会返回类似 https://example.com/api/ 这样的 URL

特殊情况：没有启用固定链接

如果你的 WordPress 网站没有启用固定链接，那么 REST API 的 URL 会有所不同。get_rest_url() 函数会使用 ?rest_route=$path 的形式来传递 API 路径。

例如：

$rest_url = get_rest_url( null, '/wp/v2/posts' );
echo $rest_url; // 输出：https://example.com/?rest_route=/wp/v2/posts

这种方式虽然也能工作，但是 URL 看起来不太美观，而且对 SEO 也不友好。强烈建议启用固定链接！

使用 Nginx 配置 REST API

在高性能的网站中，通常会使用 Nginx 来处理静态资源和反向代理。为了更好地利用 Nginx 的性能，你可以配置 Nginx 来直接处理 REST API 请求，而不需要经过 WordPress 的 PHP 解释器。

在这种情况下，你需要定义 WP_REST_API_URI 常量，并设置 use_nginx_for_rest_api 选项。

wp-config.php 文件：

define( 'WP_REST_API_URI', 'https://api.example.com/' );
add_filter( 'option_use_nginx_for_rest_api', '__return_true' );

Nginx 配置文件：

server {
    listen 443 ssl;
    server_name api.example.com;

    # ... SSL 配置 ...

    location / {
        try_files $uri $uri/ /index.php?$args; # Or directly proxy to your WordPress server
    }
}

在这种配置下，get_rest_url() 函数会直接返回 WP_REST_API_URI 常量的值。

get_rest_url() 函数与其他相关函数

函数名	功能
`get_home_url()`	获取博客的首页 URL。
`rest_get_url_prefix()`	获取 REST API 的 URL 前缀（默认为 `'wp-json'`）。
`rest_url()`	与 `get_rest_url()` 类似，但可以指定 endpoint。例如：`rest_url( 'wp/v2/posts' )`。实际上，`rest_url()` 函数内部会调用 `get_rest_url()`。
`register_rest_route()`	注册 REST API 路由。这是开发自定义 REST API endpoint 的关键函数。
`WP_REST_Request`	表示一个 REST API 请求。
`WP_REST_Response`	表示一个 REST API 响应。

安全性考虑

REST API 的安全性至关重要。默认情况下，WordPress REST API 提供了一些基本的身份验证和授权机制，例如使用 cookies 进行身份验证，以及使用 capabilities 进行授权。但是，在开发自定义 REST API endpoint 时，你需要特别注意以下几点：

输入验证： 永远不要信任用户输入。对所有输入进行严格的验证和过滤，防止 SQL 注入、XSS 攻击等。
身份验证： 确保只有经过身份验证的用户才能访问敏感的 API endpoint。
授权： 确保用户只能访问他们有权限访问的数据。使用 WordPress 的 capabilities 系统来控制访问权限。
HTTPS： 强烈建议使用 HTTPS 来加密 REST API 的流量，防止数据被窃听。
Rate Limiting： 限制 API 请求的频率，防止恶意攻击。

总结：get_rest_url() 的重要性

get_rest_url() 函数就像一个默默无闻的英雄，它隐藏在 WordPress 的底层，默默地为 REST API 提供着支持。理解它的工作原理，可以帮助你更好地理解 WordPress REST API 的架构，更好地开发自定义 REST API endpoint，更好地与其他系统进行数据交互。

希望今天的讲座对大家有所帮助。下次再见！记住，bug 终结者永远与你同在（只要你给我足够的咖啡）！

发表回复 取消回复

发表回复取消回复