阐述 WordPress `rest_meta_query` 过滤器源码：如何处理 REST API 请求中的元数据查询。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位听众，早上好！今天咱们不搞虚头巴脑的客套，直接开讲 WordPress 的 rest_meta_query 过滤器，聊聊它如何在 REST API 的洪流中，优雅地处理那些磨人的元数据查询。

开场白：元数据这磨人的小妖精

在 WordPress 的世界里，元数据就像是文章、页面、用户等等这些核心对象身上的小标签，记录着各种各样的附加信息。比如，一篇文章的阅读量、SEO 关键词、甚至是作者的心情，都可以用元数据来存储。

有了元数据，我们就能实现各种各样的高级功能。但问题来了，如果我们要通过 REST API 来查询符合特定元数据条件的内容，该怎么办呢？这时候，rest_meta_query 过滤器就闪亮登场了！它像一个经验老道的猎人，专门负责捕获 REST API 请求中的元数据查询条件，并将其转化为 WordPress 可以理解的 SQL 查询语句。

第一幕：rest_meta_query 过滤器登场

rest_meta_query 过滤器允许我们自定义如何处理 REST API 请求中的 meta_query 参数。简单来说，就是你可以拦截REST API的元查询请求，然后按照你自己的想法，将它转换成SQL查询语句，以此来获取你需要的结果。

过滤器的定义：

apply_filters( 'rest_meta_query', array $meta_query, WP_REST_Request $request, WP_REST_Controller $this )

$meta_query: 这是 WordPress 默认生成的元数据查询数组。初始状态可能是空的，也可能包含一些默认的查询条件。
$request: 这是一个 WP_REST_Request 对象，包含了整个 REST API 请求的所有信息，包括 URL 参数、请求头等等。我们的元数据查询条件，就藏在这个 $request 对象里。
$this: 这是当前 REST 控制器的实例。它可以访问一些有用的方法和属性，比如获取当前请求的帖子类型。

第二幕：解剖 REST API 请求

要理解 rest_meta_query 的工作原理，首先要搞清楚 REST API 请求是如何传递元数据查询条件的。通常，我们会使用 meta_query 参数来指定元数据查询条件。

例如，我们要查询所有 post_type 为 book，且 author 元数据值为 Jane Austen 的文章，REST API 请求可能是这样的：

/wp-json/wp/v2/book?meta_query[0][key]=author&meta_query[0][value]=Jane Austen&meta_query[0][compare]==

让我们把这个 URL 参数解析一下：

meta_query[0][key]=author: 指定元数据的键为 author。
meta_query[0][value]=Jane Austen: 指定元数据的值为 Jane Austen。
meta_query[0][compare]==: 指定比较运算符为等于（=）。

多个元数据查询条件可以通过增加索引来指定。例如，要同时满足 author 为 Jane Austen 且 genre 为 Romance 的条件：

/wp-json/wp/v2/book?meta_query[0][key]=author&meta_query[0][value]=Jane Austen&meta_query[0][compare]=&meta_query[1][key]=genre&meta_query[1][value]=Romance&meta_query[1][compare]==

第三幕：过滤器实战：拦截并处理 meta_query

现在，我们来编写一个 rest_meta_query 过滤器的例子，它可以拦截 REST API 请求中的 meta_query 参数，并将其添加到 WordPress 的查询中。

add_filter( 'rest_meta_query', 'my_custom_rest_meta_query', 10, 3 );

function my_custom_rest_meta_query( $meta_query, $request, $controller ) {
    // 1. 检查请求中是否包含 meta_query 参数
    $params = $request->get_params();

    if ( ! isset( $params['meta_query'] ) || ! is_array( $params['meta_query'] ) ) {
        return $meta_query; // 如果没有 meta_query 参数，直接返回默认的 meta_query
    }

    // 2. 遍历 meta_query 参数，构建查询条件
    $rest_meta_query = $params['meta_query'];

    foreach ( $rest_meta_query as $query ) {
        // 3. 检查每个查询条件是否包含 key、value 和 compare
        if ( ! isset( $query['key'] ) || ! isset( $query['value'] ) ) {
            continue; // 如果缺少 key 或 value，跳过此查询条件
        }

        $key     = sanitize_key( $query['key'] ); // 安全起见，对 key 进行过滤
        $value   = sanitize_text_field( $query['value'] ); // 安全起见，对 value 进行过滤
        $compare = isset( $query['compare'] ) ? strtoupper( $query['compare'] ) : '='; // 默认比较运算符为等于

        // 4. 将查询条件添加到 meta_query 数组中
        $meta_query[] = array(
            'key'     => $key,
            'value'   => $value,
            'compare' => $compare,
        );
    }

    return $meta_query;
}

代码解释：

检查 meta_query 参数： 首先，我们从 $request 对象中获取请求参数，并检查其中是否包含 meta_query 参数。如果没有，就直接返回默认的 $meta_query，不做任何修改。
遍历查询条件： 如果 meta_query 参数存在，我们就遍历它，逐个处理其中的查询条件。
验证查询条件： 对于每个查询条件，我们检查它是否包含 key 和 value。如果缺少任何一个，我们就跳过这个条件，防止出现错误。同时也对 key 和 value 进行了安全过滤，防止 SQL 注入等安全问题。
构建查询条件： 如果查询条件有效，我们就将其添加到 $meta_query 数组中。默认的比较运算符是等于（=），如果请求中指定了 compare 参数，我们就使用指定的比较运算符。

比较运算符：

compare 参数可以指定各种比较运算符，常见的包括：

运算符	含义
`=`	等于
`!=`	不等于
`>`	大于
`<`	小于
`>=`	大于等于
`<=`	小于等于
`LIKE`	包含
`NOT LIKE`	不包含
`IN`	在数组中
`NOT IN`	不在数组中
`BETWEEN`	在两个值之间
`NOT BETWEEN`	不在两个值之间
`EXISTS`	元数据存在
`NOT EXISTS`	元数据不存在

例子：使用 LIKE 运算符

如果我们要查询所有 post_type 为 book，且 author 元数据值包含 Austen 的文章，REST API 请求可以是这样的：

/wp-json/wp/v2/book?meta_query[0][key]=author&meta_query[0][value]=Austen&meta_query[0][compare]=LIKE

第四幕：更高级的用法：嵌套 meta_query

WordPress 的 meta_query 支持嵌套，允许我们构建更复杂的查询条件。例如，我们要查询所有 post_type 为 book，且满足以下条件之一的文章：

author 元数据值为 Jane Austen 且 genre 元数据值为 Romance
author 元数据值为 Charles Dickens 且 genre 元数据值为 Novel

REST API 请求可能是这样的：

/wp-json/wp/v2/book?meta_query[relation]=OR&meta_query[0][relation]=AND&meta_query[0][0][key]=author&meta_query[0][0][value]=Jane Austen&meta_query[0][0][compare]=&meta_query[0][1][key]=genre&meta_query[0][1][value]=Romance&meta_query[0][1][compare]=&meta_query[1][relation]=AND&meta_query[1][0][key]=author&meta_query[1][0][value]=Charles Dickens&meta_query[1][0][compare]=&meta_query[1][1][key]=genre&meta_query[1][1][value]=Novel&meta_query[1][1][compare]==

可以看到，嵌套的 meta_query 使用了 relation 参数来指定多个查询条件之间的关系（AND 或 OR）。

为了处理嵌套的 meta_query，我们需要修改我们的过滤器函数：

add_filter( 'rest_meta_query', 'my_custom_rest_meta_query_nested', 10, 3 );

function my_custom_rest_meta_query_nested( $meta_query, $request, $controller ) {
    // 1. 检查请求中是否包含 meta_query 参数
    $params = $request->get_params();

    if ( ! isset( $params['meta_query'] ) || ! is_array( $params['meta_query'] ) ) {
        return $meta_query; // 如果没有 meta_query 参数，直接返回默认的 meta_query
    }

    // 2. 处理 meta_query 参数
    $rest_meta_query = $params['meta_query'];
    $meta_query = my_process_meta_query( $rest_meta_query, $meta_query );

    return $meta_query;
}

function my_process_meta_query( $rest_meta_query, $meta_query ) {
    if ( ! is_array( $rest_meta_query ) ) {
        return $meta_query;
    }

    $relation = isset( $rest_meta_query['relation'] ) ? strtoupper( $rest_meta_query['relation'] ) : 'AND';

    $group = array(
        'relation' => $relation,
    );

    foreach ( $rest_meta_query as $key => $query ) {
        if ( $key === 'relation' ) {
            continue;
        }

        if ( isset( $query['key'] ) && isset( $query['value'] ) ) {
            // 处理单个 meta_query 条件
            $key     = sanitize_key( $query['key'] );
            $value   = sanitize_text_field( $query['value'] );
            $compare = isset( $query['compare'] ) ? strtoupper( $query['compare'] ) : '=';

            $group[] = array(
                'key'     => $key,
                'value'   => $value,
                'compare' => $compare,
            );
        } elseif ( is_array( $query ) ) {
            // 递归处理嵌套的 meta_query
            $group[] = my_process_meta_query( $query, array() );
        }
    }

    $meta_query[] = $group;
    return $meta_query;
}

代码解释：

my_process_meta_query 函数： 这个函数递归地处理 meta_query 参数。
处理 relation 参数： 如果 meta_query 中包含 relation 参数，我们就获取它的值，并将其作为当前查询条件组的关系。
处理单个查询条件： 如果 meta_query 中包含 key 和 value，我们就将其作为一个单独的查询条件添加到查询条件组中。
递归处理嵌套的 meta_query： 如果 meta_query 中包含一个数组，我们就递归调用 my_process_meta_query 函数来处理这个嵌套的 meta_query。

第五幕：安全注意事项

在使用 rest_meta_query 过滤器时，一定要注意安全问题。特别是，要对 key 和 value 进行过滤，防止 SQL 注入等安全漏洞。

可以使用 sanitize_key() 和 sanitize_text_field() 函数来对 key 和 value 进行过滤。

第六幕：性能优化

复杂的 meta_query 查询可能会影响性能。为了提高性能，可以考虑以下几点：

索引： 为经常用于查询的元数据键创建索引。
缓存： 缓存查询结果，避免重复查询。
限制查询复杂度： 避免构建过于复杂的 meta_query 查询。

第七幕：与其他过滤器的配合

rest_meta_query 过滤器可以与其他过滤器配合使用，实现更强大的功能。例如，可以与 rest_prepare_{$post_type} 过滤器配合使用，在 REST API 响应中添加自定义的元数据。

第八幕：总结与展望

rest_meta_query 过滤器是 WordPress REST API 中一个非常强大的工具，它可以让我们灵活地处理元数据查询。掌握了 rest_meta_query 过滤器的使用方法，就可以构建出更加强大的 WordPress REST API 应用。

今天的内容就到这里了。希望大家能够通过今天的学习，对 rest_meta_query 过滤器有一个更深入的了解。如果大家有什么问题，欢迎提问！谢谢大家！

发表回复 取消回复

发表回复取消回复