解析 WordPress `pre_get_posts` 钩子源码：在 `WP_Query` 执行前如何修改查询参数以优化性能。

各位观众，各位大佬，早上好！ 欢迎来到今天的“WordPress pre_get_posts 钩子源码深度解析：查询参数优化，性能飞升”专场。 今天咱们不搞虚的，直接上干货，把 pre_get_posts 这个WordPress查询界的“幕后大佬”扒个底朝天，看看它如何在你不知不觉中操控着WordPress的每一次查询，以及我们如何利用它来提升网站性能。

一、 什么是 pre_get_posts ?

首先，咱们得搞清楚，pre_get_posts 到底是个啥？ 简单来说，它就是一个在 WP_Query 对象执行查询 之前 触发的钩子。你可以把它想象成一个“拦截器”，在WordPress准备去数据库捞数据之前，给你一个机会，让你有机会“动手动脚”，修改查询参数，最终影响查询的结果。

举个例子，就像你想去餐厅点菜，还没跟服务员说你要什么，这时餐厅经理跑过来问你：“要不要给你加点辣椒？” 你说“好”，那最后你的菜就会带辣椒。 pre_get_posts 就相当于这个餐厅经理，而你可以通过它来修改查询参数，比如：

• 修改文章数量：原本首页显示10篇文章，你可以改成5篇，减轻服务器压力。
• 修改文章排序方式：原本按发布时间排序，你可以改成按评论数排序，让热门文章更显眼。
• 排除特定分类的文章：比如你不想在首页显示广告类的文章。
• 自定义字段查询：根据自定义字段的值来筛选文章，实现更复杂的查询需求。

总之，pre_get_posts 给了你极大的灵活性，让你能够根据自己的需求，精准控制WordPress的查询行为。

二、 pre_get_posts 的源码剖析

理论讲完了，现在咱们来扒一扒 pre_get_posts 的源码，看看它到底是怎么工作的。

pre_get_posts 钩子位于 wp-includes/class-wp-query.php 文件中，在 WP_Query::get_posts() 方法中被调用。 具体代码如下（简化版）：

<?php
class WP_Query {
    //... 其他代码 ...

    public function get_posts() {
        //... 其他代码 ...

        /**
         * Fires before the query variable object is parsed.
         *
         * @since 1.5.0
         *
         * @param WP_Query $this The WP_Query instance (passed by reference).
         */
        do_action_ref_array( 'pre_get_posts', array( &$this ) );

        //... 其他代码 ...
    }

    //... 其他代码 ...
}
?>

关键就在 do_action_ref_array( 'pre_get_posts', array( &$this ) ); 这行代码。

• do_action_ref_array 是 WordPress 触发钩子的函数，它可以传递多个参数给钩子函数。
• 'pre_get_posts' 就是钩子的名称，也就是我们要在 add_action 中使用的第一个参数。
• array( &$this ) 传递了一个参数，就是当前的 WP_Query 对象本身（注意是引用传递 &）。这意味着，在你的钩子函数中，你可以直接修改 WP_Query 对象的属性，从而改变查询参数。

总结一下：

1. WP_Query 在执行查询之前，会触发 pre_get_posts 钩子。
2. 通过 do_action_ref_array，WP_Query 对象本身会被传递给你的钩子函数。
3. 你可以在钩子函数中，通过修改 WP_Query 对象的属性，来改变查询参数。

三、 如何使用 pre_get_posts 修改查询参数

现在，咱们来实战一下，看看如何使用 pre_get_posts 钩子来修改查询参数。

首先，你需要创建一个函数，并将其绑定到 pre_get_posts 钩子上。 通常，你会在主题的 functions.php 文件或者自定义插件中添加如下代码：

<?php
function my_custom_pre_get_posts( $query ) {
    // 在这里修改查询参数
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts' );
?>

其中：

• my_custom_pre_get_posts 是你自定义的函数名，你可以随意修改。
• $query 是传递给你的函数的 WP_Query 对象。

重要提示：

在使用 pre_get_posts 时，一定要小心！ 因为它会影响 所有 的 WP_Query 查询，包括首页、分类页、搜索页等等。 如果你不加判断，随意修改查询参数，很可能会导致网站出现意想不到的问题。

因此，在使用 pre_get_posts 时， 务必进行条件判断 ，只在需要修改查询参数的地方进行修改。

常用的条件判断函数：

函数	作用
is_home()	判断是否是首页
is_front_page()	判断是否是静态首页
is_archive()	判断是否是归档页（分类页、标签页、日期页等）
is_category()	判断是否是分类页
is_tag()	判断是否是标签页
is_search()	判断是否是搜索页
is_singular()	判断是否是单篇文章或单页面
is_admin()	判断是否是后台管理页面
$query->is_main_query()	判断是否是主查询

下面，我们来看几个具体的例子：

1. 修改首页文章数量：

<?php
function my_custom_pre_get_posts( $query ) {
    if ( is_home() && $query->is_main_query() ) {
        $query->set( 'posts_per_page', 5 ); // 将首页文章数量设置为 5
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts' );
?>

这段代码的意思是：

• 如果当前是首页 并且 是主查询，那么就将 posts_per_page 参数设置为 5。

posts_per_page 是 WP_Query 对象的一个属性，用于指定每页显示的文章数量。 你可以通过 set() 方法来修改这个属性。

$query->is_main_query() 非常重要！ 它可以确保你只修改 主查询 的参数，避免影响其他查询。 举个例子，如果你的主题使用了 WP_Query 来显示侧边栏的最新文章，如果不加 is_main_query() 判断，那么侧边栏的文章数量也会被修改，这通常不是你想要的结果。

2. 排除特定分类的文章：

<?php
function my_custom_pre_get_posts( $query ) {
    if ( is_home() && $query->is_main_query() ) {
        $query->set( 'category__not_in', array( 10, 12 ) ); // 排除 ID 为 10 和 12 的分类
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts' );
?>

这段代码的意思是：

• 如果当前是首页 并且 是主查询，那么就排除 ID 为 10 和 12 的分类的文章。

category__not_in 是 WP_Query 对象的一个属性，用于排除特定分类的文章。 它的值是一个数组，包含要排除的分类的 ID。

3. 按评论数排序文章：

<?php
function my_custom_pre_get_posts( $query ) {
    if ( is_category( 'popular' ) && $query->is_main_query() ) { //只在分类 'popular' 下生效
        $query->set( 'orderby', 'comment_count' ); // 按评论数排序
        $query->set( 'order', 'DESC' ); // 降序排列
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts' );
?>

这段代码的意思是：

• 如果当前是分类 ‘popular’ 并且 是主查询，那么就按评论数排序文章，并降序排列（评论数最多的文章排在最前面）。

orderby 和 order 是 WP_Query 对象的属性，用于指定排序方式。 常用的 orderby 值包括：

orderby 值	排序方式
'none'	不排序
'ID'	按文章 ID 排序
'author'	按作者排序
'title'	按标题排序
'name'	按文章别名排序
'date'	按发布日期排序
'modified'	按修改日期排序
'rand'	随机排序
'comment_count'	按评论数排序
'menu_order'	按菜单顺序排序
'meta_value'	按自定义字段的值排序
'meta_value_num'	按自定义字段的数值排序

order 的值可以是 'ASC' （升序）或 'DESC' （降序）。

4. 自定义字段查询：

<?php
function my_custom_pre_get_posts( $query ) {
    if ( is_home() && $query->is_main_query() ) {
        $query->set( 'meta_key', 'my_custom_field' ); // 自定义字段的键名
        $query->set( 'meta_value', 'some_value' ); // 自定义字段的值
        $query->set( 'meta_compare', '=' ); // 比较运算符
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts' );
?>

这段代码的意思是：

• 如果当前是首页 并且 是主查询，那么就查询自定义字段 my_custom_field 的值为 some_value 的文章。

meta_key, meta_value, meta_compare 是 WP_Query 对象的属性，用于进行自定义字段查询。

• meta_key 指定自定义字段的键名。
• meta_value 指定自定义字段的值。
• meta_compare 指定比较运算符，常用的值包括：'=' （等于）, '!=' （不等于）, '>' （大于）, '<' （小于）, '>=' （大于等于）, '<=' （小于等于）, 'LIKE' （模糊匹配）, 'NOT LIKE' （不模糊匹配）, 'IN' （包含）, 'NOT IN' （不包含）, 'BETWEEN' （介于）, 'NOT BETWEEN' （不介于）, 'EXISTS' （存在）, 'NOT EXISTS' （不存在）。

5. 更高级的用法：使用 WP_Meta_Query 进行复杂的自定义字段查询

如果你需要进行更复杂的自定义字段查询，比如查询多个自定义字段，或者进行嵌套查询，那么可以使用 WP_Meta_Query 类。

<?php
function my_custom_pre_get_posts( $query ) {
    if ( is_home() && $query->is_main_query() ) {
        $meta_query = array(
            'relation' => 'AND', // 多个条件之间的关系，可以是 'AND' 或 'OR'
            array(
                'key' => 'my_custom_field_1',
                'value' => 'value_1',
                'compare' => '='
            ),
            array(
                'key' => 'my_custom_field_2',
                'value' => array( 'value_2', 'value_3' ),
                'compare' => 'IN'
            )
        );
        $query->set( 'meta_query', $meta_query );
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts' );
?>

这段代码的意思是：

• 如果当前是首页 并且 是主查询，那么就查询同时满足以下两个条件的文章：
  • my_custom_field_1 的值为 value_1。
  • my_custom_field_2 的值为 value_2 或 value_3。

四、 pre_get_posts 优化性能的技巧

pre_get_posts 不仅可以修改查询参数，还可以用来优化网站性能。 以下是一些常用的技巧：

1. 减少查询数量：

   • 尽量避免在循环中使用 WP_Query， 尽量在循环 外部 准备好所有需要的数据。
   • 使用 get_posts() 函数代替 WP_Query， 如果你只需要获取文章数据，而不需要分页等功能，那么 get_posts() 函数更加轻量级。
   • 使用缓存，将查询结果缓存起来，避免重复查询数据库。 WordPress 提供了 WP_Object_Cache 类，你可以使用它来缓存查询结果。

2. 优化查询参数：

   • 只查询需要的字段， 尽量避免查询所有字段。 可以使用 fields 参数来指定需要查询的字段，例如：$query->set( 'fields', 'ids' ); 只查询文章 ID。
   • 使用正确的排序方式， 避免使用复杂的排序方式，比如随机排序，因为随机排序会消耗大量的服务器资源。
   • 使用索引，确保数据库表中的相关字段已经创建了索引。 索引可以大大提高查询速度。

3. 避免过度使用 pre_get_posts：

   • pre_get_posts 会影响 所有 的 WP_Query 查询，因此要谨慎使用。
   • 尽量将查询逻辑放在模板文件中，而不是放在 pre_get_posts 钩子中。 这样可以更容易地控制查询行为，并且可以避免影响其他查询。
   • 使用插件来实现复杂的功能，而不是自己编写大量的代码。 已经有很多优秀的 WordPress 插件可以帮助你实现各种复杂的功能，比如自定义查询、高级筛选等等。

五、 pre_get_posts 的注意事项

1. 优先级问题： 多个函数绑定到 pre_get_posts 钩子上时，它们的执行顺序由优先级决定。 优先级越小的函数，越先执行。 默认优先级是 10。 你可以使用 add_action 函数的第三个参数来指定优先级，例如：add_action( 'pre_get_posts', 'my_custom_pre_get_posts', 1 ); 将优先级设置为 1，表示该函数最先执行。

2. 死循环问题： 如果你在 pre_get_posts 钩子中又调用了 WP_Query， 那么可能会导致死循环。 因此，要避免在 pre_get_posts 钩子中调用 WP_Query，或者确保你的代码能够正确地跳出循环。

3. 调试问题： pre_get_posts 钩子在后台执行，因此不容易调试。 你可以使用 var_dump() 或 error_log() 函数来输出调试信息，或者使用 WordPress 的调试插件，比如 Query Monitor，来查看查询参数和查询结果。

六、总结

总的来说，pre_get_posts 是一个非常强大的钩子，可以让你在 WP_Query 执行之前修改查询参数，从而实现各种自定义的查询需求，并优化网站性能。 但同时也需要谨慎使用，避免出现问题。

记住，在使用 pre_get_posts 时，一定要：

• 进行条件判断
• 避免过度使用
• 注意优先级
• 避免死循环
• 进行充分的测试和调试

掌握了 pre_get_posts， 你的WordPress网站性能就能更上一层楼！

今天的讲座就到这里，希望对大家有所帮助！ 谢谢大家！