剖析 `pre_get_posts` 钩子在 `WP_Query` 类中的作用，解释它如何允许开发者在查询执行前修改查询参数？ - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

大家好！今天咱们来聊聊WordPress里一个非常强大的钩子——pre_get_posts。别看它名字有点长，实际上用起来可方便了。它可以让你在WordPress真正执行数据库查询之前，修改查询参数，从而定制网站的各种页面和内容展示方式。

想象一下，你是个餐厅老板，顾客点了菜，但是你能在厨师开始做之前，偷偷地把菜单改了，加点特色菜，或者把不新鲜的菜换掉。 pre_get_posts 就相当于你这个餐厅老板的角色，WP_Query 就是那个厨师，而顾客点的菜就是WordPress默认的查询参数。

WP_Query 的工作流程：

首先，我们需要理解 WP_Query 在 WordPress 中扮演的角色。简单来说，它就是一个查询类，负责根据你提供的参数从数据库里拉取数据。这个过程大致是这样的：

接收参数： 比如你想获取文章，或者某个分类下的文章，或者某个作者的文章，这些都作为参数传递给 WP_Query。
构建 SQL 查询： WP_Query 会根据这些参数，生成一个 SQL 查询语句，这个语句就是告诉数据库“我要哪些数据”。
执行查询： 执行SQL查询语句，从数据库中检索数据。
返回结果： 将查询结果（通常是文章对象）返回给你。

pre_get_posts 登场：

pre_get_posts 钩子允许你在第2步之前，也就是 WP_Query 构建 SQL 查询之前，拦截并修改查询参数。这样，你就可以改变最终的查询结果。

为什么需要 pre_get_posts？

你可能会问：“WordPress 已经有很多选项可以定制查询了，为什么还需要 pre_get_posts？” 问得好！虽然 WordPress 提供了很多选项，比如在主题里设置文章数量，或者使用分类目录来组织内容，但这些选项往往不够灵活。比如，你想：

在首页显示不同类型的文章（比如，既有普通文章，又有自定义文章类型）。
根据用户的角色来显示不同的文章。
动态地修改文章排序方式。
添加自定义的查询参数。

这些情况下，pre_get_posts 就能派上大用场了。它给你提供了完全的控制权，让你能够以编程的方式来定制查询。

如何使用 pre_get_posts？

使用 pre_get_posts 非常简单，只需要几步：

创建函数： 首先，你需要创建一个函数，这个函数会在 pre_get_posts 钩子被触发时执行。
添加钩子： 使用 add_action() 函数，将你的函数挂载到 pre_get_posts 钩子上。
修改查询： 在你的函数里，使用 $query 对象来修改查询参数。

看个例子：

<?php
function my_custom_pre_get_posts( $query ) {
    // 确保只修改主查询
    if ( $query->is_main_query() && ! is_admin() ) {
        // 修改首页显示的文章数量
        $query->set( 'posts_per_page', 6 );

        // 添加自定义文章类型
        $query->set( 'post_type', array( 'post', 'my_custom_post_type' ) );

        //按照标题排序
        $query->set( 'orderby', 'title' );
        $query->set( 'order', 'ASC' ); //升序排列
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts' );
?>

这个例子做了这些事情：

my_custom_pre_get_posts( $query )： 定义了一个名为 my_custom_pre_get_posts 的函数，它接收一个 $query 对象作为参数。这个 $query 对象就是 WP_Query 的实例，你可以通过它来访问和修改查询参数。
if ( $query->is_main_query() && ! is_admin() )： 这是一个重要的判断条件。 is_main_query() 确保你只修改主查询（也就是 WordPress 默认的查询，比如首页、分类页等）。 ! is_admin() 确保你不在后台修改查询，因为后台的查询可能会影响管理功能。
$query->set( 'posts_per_page', 6 )： 使用 $query->set() 方法来修改查询参数。这里将首页显示的文章数量设置为 6。
$query->set( 'post_type', array( 'post', 'my_custom_post_type' ) )： 添加了一个自定义文章类型 my_custom_post_type，让首页同时显示普通文章和自定义文章。
add_action( 'pre_get_posts', 'my_custom_pre_get_posts' )： 将 my_custom_pre_get_posts 函数挂载到 pre_get_posts 钩子上。这意味着，当 WordPress 执行查询之前，会自动调用这个函数。

$query 对象的方法：

$query 对象提供了很多方法来访问和修改查询参数。下面是一些常用的方法：

方法	描述	示例
`get( $query_var )`	获取指定查询变量的值。	`$posts_per_page = $query->get( 'posts_per_page' );` 获取当前每页显示的文章数量。
`set( $query_var, $value )`	设置指定查询变量的值。	`$query->set( 'posts_per_page', 10 );` 设置每页显示的文章数量为 10。
`is_home()`	判断是否是首页。	`if ( $query->is_home() ) { ... }`
`is_archive()`	判断是否是存档页（分类页、标签页等）。	`if ( $query->is_archive() ) { ... }`
`is_category()`	判断是否是分类页。	`if ( $query->is_category() ) { ... }`
`is_tag()`	判断是否是标签页。	`if ( $query->is_tag() ) { ... }`
`is_search()`	判断是否是搜索结果页。	`if ( $query->is_search() ) { ... }`
`is_single()`	判断是否是单篇文章页。	`if ( $query->is_single() ) { ... }`
`is_page()`	判断是否是页面。	`if ( $query->is_page() ) { ... }`
`is_main_query()`	判断是否是主查询。	`if ( $query->is_main_query() ) { ... }`
`get_queried_object()`	获取当前查询的对象（比如，在分类页，可以获取当前分类对象）。	`$category = $query->get_queried_object();` 获取当前分类对象。然后可以通过 `$category->term_id` 获取分类ID, `$category->name` 获取分类名等等。
`set_404()`	将当前查询设置为 404 页面。	`$query->set_404();`
`is_404()`	检查当前查询是否为 404 页面。	`if ( $query->is_404() ) { ... }`
`parse_query()`	解析查询参数（通常不需要手动调用，`WP_Query` 会自动调用）。	很少用到，除非你需要自定义更底层的查询逻辑。
`get_posts()`	执行查询并返回结果（通常不需要手动调用，`WP_Query` 会自动调用）。	同样，一般不用手动调用。
`have_posts()`	检查是否有文章可供循环输出。	`if ( $query->have_posts() ) { while ( $query->have_posts() ) { $query->the_post(); ... } }` 在循环输出文章时使用。注意这里是 `$query->the_post()` 而不是 `the_post()`，因为你是在一个自定义的 `WP_Query` 对象中使用。
`the_post()`	在循环中设置当前文章。	同上。
`rewind_posts()`	重置文章指针，回到文章列表的开头。	`$query->rewind_posts();` 如果你需要在同一个查询中多次循环输出文章，可以使用它。
`found_posts`	查询到的文章总数（未分页）。	`echo '总共有 ' . $query->found_posts . ' 篇文章。';`
`max_num_pages`	总页数（分页后）。	`echo '总共有 ' . $query->max_num_pages . ' 页。';`
`query_vars`	包含所有查询变量的数组。	`print_r( $query->query_vars );` 可以打印出所有查询变量，方便调试。

更复杂的例子：根据用户角色修改查询

假设你想根据用户的角色来显示不同的文章。比如，管理员可以看到所有文章，而普通用户只能看到公开的文章。可以这样做：

<?php
function my_custom_pre_get_posts_user_role( $query ) {
    if ( $query->is_main_query() && ! is_admin() ) {
        $current_user = wp_get_current_user();

        if ( in_array( 'administrator', (array) $current_user->roles ) ) {
            // 管理员可以看到所有文章，不需要修改查询
        } else {
            // 普通用户只能看到公开的文章
            $query->set( 'post_status', 'publish' );
        }
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts_user_role' );
?>

这个例子做了这些事情：

wp_get_current_user()： 获取当前用户对象。
in_array( 'administrator', (array) $current_user->roles )： 判断当前用户是否是管理员。
$query->set( 'post_status', 'publish' )： 如果不是管理员，则将 post_status 设置为 publish，只显示已发布的文章。

再来一个例子：自定义排序

假设你想在某个特定的分类页，按照文章的修改时间倒序排列，而不是按照默认的发布时间。

<?php
function my_custom_pre_get_posts_category_order( $query ) {
    if ( $query->is_category( 'my-special-category' ) && $query->is_main_query() && ! is_admin() ) {
        $query->set( 'orderby', 'modified' );
        $query->set( 'order', 'DESC' );
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts_category_order' );
?>

这个例子做了这些事情：

$query->is_category( 'my-special-category' )： 判断当前是否是 my-special-category 这个分类页。你需要将 my-special-category 替换成你实际的分类别名（slug）。
$query->set( 'orderby', 'modified' )： 将排序方式设置为按照修改时间。
$query->set( 'order', 'DESC' )： 将排序顺序设置为倒序。

调试 pre_get_posts：

有时候，你的 pre_get_posts 代码可能不会按照预期工作。这时候，你需要调试。以下是一些调试技巧：

var_dump( $query->query_vars )： 在你的函数里，使用 var_dump() 函数来打印 $query->query_vars 数组。这可以让你看到当前所有的查询参数，方便你查找问题。

<?php
function my_custom_pre_get_posts_debug( $query ) {
    if ( $query->is_main_query() && ! is_admin() ) {
        var_dump( $query->query_vars );
        // 你的其他代码
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts_debug' );
?>

die()： 在关键的地方使用 die() 函数来停止代码执行，方便你观察代码的执行流程。

<?php
function my_custom_pre_get_posts_debug( $query ) {
    if ( $query->is_main_query() && ! is_admin() ) {
        echo 'pre_get_posts is running!';
        die();
        // 你的其他代码
    }
}
add_action( 'pre_get_posts', 'my_custom_pre_get_posts_debug' );
?>

注释掉其他代码： 如果你有很多 pre_get_posts 代码，可以先注释掉一部分，然后逐步放开，来找到导致问题的代码。
使用插件： 有一些插件可以帮助你调试 WP_Query，比如 Query Monitor。它们可以显示 SQL 查询语句，以及其他有用的信息。

注意事项：

性能： pre_get_posts 会在每次查询之前执行，所以你的代码应该尽可能高效，避免影响网站性能。
冲突： 如果多个插件或主题都使用了 pre_get_posts 钩子，可能会发生冲突。尽量避免修改同一个查询参数，或者使用优先级来控制代码的执行顺序。
安全性： 如果你允许用户输入来修改查询参数，一定要进行安全过滤，防止 SQL 注入等安全问题。

总结：

pre_get_posts 是一个非常强大的钩子，可以让你灵活地定制 WordPress 的查询。通过它，你可以实现各种各样的功能，比如自定义首页显示、根据用户角色显示不同内容、动态修改排序方式等等。只要你掌握了它的用法，就能让你的 WordPress 网站更加个性化和强大。希望今天的讲解对你有所帮助！记住，实践才是检验真理的唯一标准，多写代码，多尝试，你就能掌握 pre_get_posts 的精髓。谢谢大家！

发表回复 取消回复

发表回复取消回复