探究 WordPress `pre_get_posts` 钩子源码：在 `WP_Query` 执行前如何修改查询参数。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位老铁，晚上好！今天咱们聊点硬核的，扒一扒 WordPress 的 pre_get_posts 钩子，看看它到底是个什么东西，以及怎么用它在 WP_Query 执行之前悄咪咪地修改查询参数，让 WordPress 按照咱们的意思去干活。

一、什么是 pre_get_posts ？它是干嘛的？

简单来说，pre_get_posts 是 WordPress 提供的一个 action 钩子。啥是钩子？你可以把它想象成一个预留的“小机关”， WordPress 在执行某些关键操作之前，会先触发这些“小机关”。咱们可以在这些“小机关”上挂上咱们自己的代码（也就是一个函数），让 WordPress 在执行关键操作之前先执行咱们的代码。

pre_get_posts 这个钩子就厉害了，它会在 WP_Query 对象执行 get_posts() 方法之前被触发。而 WP_Query 对象是 WordPress 用来查询文章、页面、自定义文章类型等等的核心类。这意味着，我们可以通过 pre_get_posts 钩子，在 WordPress 真正开始查询数据之前，修改 WP_Query 对象的查询参数，从而改变 WordPress 的查询结果。

举个例子： 假设你想在首页只显示某个分类的文章，或者想把文章的排序方式改成按评论数排序，又或者你想限制搜索结果只显示某个自定义文章类型，这些都可以通过 pre_get_posts 来实现。

二、 pre_get_posts 钩子怎么用？代码说话！

要使用 pre_get_posts 钩子，我们需要创建一个函数，然后把这个函数挂载到 pre_get_posts 这个 action 上。就像这样：

add_action( 'pre_get_posts', 'my_custom_query' );

function my_custom_query( $query ) {
    // 在这里修改 $query 对象
}

这段代码的意思是：当 pre_get_posts 钩子被触发时， WordPress 会自动执行 my_custom_query 这个函数，并且会把当前的 WP_Query 对象作为参数传递给这个函数。

重点来了，这个 $query 对象就是我们修改查询参数的关键！我们可以通过 $query 对象的方法来修改各种查询参数，例如：

set() 方法：设置任意查询参数
set_query_var() 方法：设置查询变量
is_main_query() 方法：判断是否是主查询
is_home() 方法：判断是否是首页
is_category() 方法：判断是否是分类页
is_tag() 方法：判断是否是标签页
is_search() 方法：判断是否是搜索页
is_admin() 方法：判断是否是后台

三、实战演练：几个常见的使用场景

说了这么多，不如来点实际的。咱们来看几个常见的 pre_get_posts 使用场景，边看代码边理解。

1. 在首页只显示某个分类的文章

假设你想在首页只显示 ID 为 10 的分类的文章，可以这样写：

add_action( 'pre_get_posts', 'my_home_page_query' );

function my_home_page_query( $query ) {
    if ( $query->is_home() && $query->is_main_query() ) {
        $query->set( 'cat', '10' );
    }
}

这段代码的意思是：

首先，我们判断当前是否是首页，并且是否是主查询（is_main_query() 用来判断是否是 WordPress 默认的主查询，避免影响其他地方的查询）。
如果是首页并且是主查询，我们就使用 $query->set( 'cat', '10' ) 来设置 cat 参数为 10。 cat 参数是 WordPress 用来指定分类 ID 的参数。

2. 修改文章排序方式为按评论数排序

如果你想把文章的排序方式改成按评论数排序，可以这样写：

add_action( 'pre_get_posts', 'my_comment_count_order' );

function my_comment_count_order( $query ) {
    if ( ! is_admin() ) { // 避免影响后台
        $query->set( 'orderby', 'comment_count' );
        $query->set( 'order', 'DESC' ); // 降序排列
    }
}

这段代码的意思是：

首先，我们使用 ! is_admin() 来判断当前是否是后台，避免影响后台的查询。
如果不是后台，我们就使用 $query->set( 'orderby', 'comment_count' ) 来设置 orderby 参数为 comment_count，表示按评论数排序。
然后，我们使用 $query->set( 'order', 'DESC' ) 来设置 order 参数为 DESC，表示降序排列（评论数多的文章排在前面）。

3. 限制搜索结果只显示某个自定义文章类型

假设你有一个自定义文章类型叫做 product，你想让搜索结果只显示 product 类型的文章，可以这样写：

add_action( 'pre_get_posts', 'my_search_query' );

function my_search_query( $query ) {
    if ( $query->is_search() && $query->is_main_query() ) {
        $query->set( 'post_type', 'product' );
    }
}

这段代码的意思是：

首先，我们判断当前是否是搜索页，并且是否是主查询。
如果是搜索页并且是主查询，我们就使用 $query->set( 'post_type', 'product' ) 来设置 post_type 参数为 product，表示只显示 product 类型的文章。

4. 复杂查询：多个条件组合

pre_get_posts 还可以处理更复杂的查询条件。比如，我想在某个分类下，只显示某个标签下的文章。

add_action( 'pre_get_posts', 'my_complex_query' );

function my_complex_query( $query ) {
    if ( $query->is_category(12) && $query->is_main_query() ) { // 分类ID为12
        $query->set( 'tag_id', 5 ); // 标签ID为5
    }
}

这段代码会在分类 ID 为 12 的页面，仅显示标签 ID 为 5 的文章。

四、 pre_get_posts 的注意事项和最佳实践

虽然 pre_get_posts 很强大，但是在使用的时候也需要注意一些事项，避免踩坑：

避免影响后台： 尽量在使用 pre_get_posts 的时候，使用 ! is_admin() 来判断当前是否是后台，避免影响后台的查询。否则，你可能会发现后台的文章列表也受到了影响，导致无法正常管理文章。
判断是否是主查询： 使用 is_main_query() 来判断是否是主查询，避免影响其他地方的查询。 WordPress 中可能存在多个 WP_Query 对象，如果不对主查询进行判断，可能会影响到其他地方的查询结果。
性能优化： 尽量避免在 pre_get_posts 中执行复杂的逻辑，因为每次查询都会触发这个钩子，如果逻辑太复杂，可能会影响网站的性能。可以考虑使用缓存来优化性能。
参数覆盖： 注意 pre_get_posts 会覆盖主题或插件中设置的查询参数。如果你的主题或插件已经设置了一些查询参数，那么 pre_get_posts 中设置的参数可能会覆盖它们。因此，在使用 pre_get_posts 的时候，需要注意参数的优先级。
调试技巧： 如果你的 pre_get_posts 代码没有生效，可以使用 var_dump( $query->request ) 来输出最终的 SQL 查询语句，看看是否符合预期。这可以帮助你找到问题所在。另外，可以尝试使用 die() 函数来中断代码的执行，逐步调试，找到问题的根源。

五、源码分析： pre_get_posts 到底是怎么工作的？

要彻底理解 pre_get_posts，最好的方法就是看看源码。让我们简单地追踪一下 WP_Query 类的 get_posts() 方法，看看 pre_get_posts 钩子在哪里被触发。

简单来说，在 WP_Query::get_posts() 方法中，会调用 do_action_ref_array( 'pre_get_posts', array( &$this ) ) 触发 pre_get_posts 钩子。这意味着，在真正开始查询数据库之前， WordPress 会把当前的 WP_Query 对象传递给所有挂载到 pre_get_posts 钩子上的函数，让这些函数有机会修改查询参数。

更具体地，你可以找到 wp-includes/class-wp-query.php 文件，搜索 do_action_ref_array( 'pre_get_posts' 就能找到这段代码。

六、总结： pre_get_posts 是你的好帮手

pre_get_posts 钩子是 WordPress 开发中一个非常强大的工具，可以让你在 WP_Query 执行之前灵活地修改查询参数，从而实现各种各样的自定义查询需求。只要你掌握了它的用法，就可以轻松地控制 WordPress 的查询结果，让你的网站更加个性化和功能强大。

表格总结:

功能	方法/参数	说明
修改查询参数	`$query->set( 'parameter', 'value' )`	设置任意查询参数，例如 `cat`, `orderby`, `post_type` 等
判断是否是主查询	`$query->is_main_query()`	确保只修改主查询，避免影响其他地方的查询
判断是否是后台	`! is_admin()`	避免影响后台的查询
判断是否是首页/分类页/搜索页等	`$query->is_home()`, `$query->is_category()`…	根据不同的页面类型，执行不同的查询修改
查看最终的 SQL 查询语句	`var_dump( $query->request )`	调试工具，可以帮助你了解 WordPress 最终生成的 SQL 查询语句，检查查询参数是否正确

希望今天的分享对大家有所帮助。记住，多看文档，多写代码，多调试，你也能成为 WordPress 大神！下次再见！

发表回复 取消回复

发表回复取消回复