大家好！我是你们今天的WordPress考古学家，今天要带大家深入挖掘 WP_Query 这个WordPress核心类中的宝藏——query_vars 属性。
导言：WP_Query 的心脏——query_vars
WP_Query 类是WordPress的核心，负责从数据库中检索文章（或者其他类型的帖子、页面等）。它就像一个经验丰富的图书馆管理员，你告诉它你要找什么书（或者哪类型的文章），它就能帮你找到。而 query_vars，就是这个图书馆管理员的索引卡片柜，里面记录了你提出的各种要求，比如你想找哪个作者写的书，或者哪个主题的书，等等。
简单来说，query_vars 属性是一个数组，它存储了所有影响查询结果的参数。理解它，你就理解了 WP_Query 的精髓，就能更灵活地控制WordPress的查询行为，定制出符合你需求的页面和功能。
第一部分：query_vars 的结构和内容
query_vars 属性是一个关联数组，键是参数名，值是参数值。这些参数控制着查询的各个方面，比如要获取的文章类型、数量、排序方式等等。
让我们先看一个例子：
<?php
$args = array(
'post_type' => 'post', // 只获取文章
'posts_per_page' => 10, // 每页显示10篇文章
'category_name' => 'news', // 只获取分类为 "news" 的文章
'orderby' => 'date', // 按照日期排序
'order' => 'DESC', // 降序排列
);
$query = new WP_Query( $args );
// 现在，我们可以看看 $query 对象的 query_vars 属性
// print_r( $query->query_vars );
?>如果你取消注释 print_r( $query->query_vars );，你会看到类似下面的输出（简化版，实际输出会包含更多默认参数）：
Array
(
[post_type] => post
[posts_per_page] => 10
[category_name] => news
[orderby] => date
[order] => DESC
[error] =>
[m] =>
[p] => 0
[post_parent] =>
[subpost] =>
[subpost_id] =>
[attachment] =>
[attachment_id] => 0
[name] =>
[static] =>
[pagename] =>
[page_id] => 0
[second] =>
[minute] =>
[hour] =>
[day] => 0
[monthnum] => 0
[year] => 0
[w] => 0
[category_name] => news
[tag] =>
[cat] =>
[tag_id] =>
[author] =>
[author_name] =>
[feed] =>
[tb] =>
[paged] => 0
[meta_key] =>
[meta_value] =>
[preview] =>
[s] =>
[sentence] =>
[fields] =>
[menu_order] =>
=>
[category__in] => Array
(
)
[category__not_in] => Array
(
)
[category__and] => Array
(
)
[post__in] => Array
(
)
[post__not_in] => Array
(
)
[tag__in] => Array
(
)
[tag__not_in] => Array
(
)
[tag__and] => Array
(
)
[tag_slug__in] => Array
(
)
[tag_slug__not_in] => Array
(
)
[tag_slug__and] => Array
(
)
[post_parent__in] => Array
(
)
[post_parent__not_in] => Array
(
)
[author__in] => Array
(
)
[author__not_in] => Array
(
)
)可以看到，我们传入的参数都成为了 query_vars 的一部分。
常见的 query_vars 参数类型
query_vars 包含各种各样的参数，可以大致分为以下几类：
- 文章类型 (Post Type)：控制要获取的文章类型，比如
'post'（文章）、'page'（页面）、'attachment'（附件）或者自定义文章类型。'post_type'：指定文章类型，可以是单个类型或者一个类型数组。'post_status'：指定文章状态，比如'publish'（已发布）、'draft'（草稿）、'private'（私有）等等。
- 分页 (Pagination)：控制分页显示。
'posts_per_page'：每页显示的文章数量。'paged'：当前页码。'offset'：跳过多少篇文章。
- 分类和标签 (Category & Tag)：控制基于分类和标签的筛选。
'cat'：分类 ID。'category_name'：分类别名。'tag'：标签别名。'tag_id'：标签 ID。'category__in'、'category__not_in'、'category__and'：更精细的分类筛选。'tag__in'、'tag__not_in'、'tag__and'：更精细的标签筛选。'tag_slug__in'、'tag_slug__not_in'、'tag_slug__and'：基于标签别名的更精细的筛选。
- 作者 (Author)：控制基于作者的筛选。
'author'：作者 ID。'author_name'：作者别名。'author__in'、'author__not_in'：更精细的作者筛选。
- 排序 (Ordering)：控制文章的排序方式。
'orderby'：排序的依据，比如'date'（日期）、'title'（标题）、'comment_count'（评论数）等等。'order'：排序的顺序，'ASC'（升序）或者'DESC'（降序）。
- 日期 (Date)：控制基于日期的筛选。
'year'：年份。'monthnum'：月份。'day'：天。
- 关键词搜索 (Search)：控制关键词搜索。
's'：搜索关键词。
- 自定义字段 (Custom Fields)：控制基于自定义字段的筛选。
'meta_key'：自定义字段的键名。'meta_value'：自定义字段的值。'meta_compare'：自定义字段值的比较方式，比如'='（等于）、'!='（不等于）、'>'（大于）等等。
- 其他参数：还有一些其他参数，比如
'post__in'（只获取指定 ID 的文章）、'post__not_in'（排除指定 ID 的文章）等等。
第二部分：query_vars 的赋值和传递
query_vars 的赋值和传递方式主要有以下几种：
-
通过
WP_Query构造函数的参数：这是最常见的方式，就像我们在前面的例子中看到的那样。<?php $args = array( 'post_type' => 'post', 'posts_per_page' => 5, ); $query = new WP_Query( $args ); ?> -
通过 URL 参数：WordPress 会自动解析 URL 中的参数，并将它们添加到
query_vars中。例如，访问http://example.com/?cat=1&paged=2，WordPress 会将cat设置为1，将paged设置为2。 -
通过
pre_get_posts动作：这是一个非常强大的钩子，允许你在WP_Query对象执行查询之前修改它的query_vars。这对于自定义查询逻辑非常有用。<?php function my_custom_query( $query ) { if ( is_home() && $query->is_main_query() ) { $query->set( 'posts_per_page', 3 ); // 在首页只显示3篇文章 } } add_action( 'pre_get_posts', 'my_custom_query' ); ?>代码解释：
pre_get_posts是一个动作钩子，在WP_Query对象执行查询之前触发。my_custom_query是我们自定义的函数，用于修改query_vars。is_home()检查当前是否是首页。$query->is_main_query()检查当前是否是主查询（也就是WordPress默认的查询）。$query->set( 'posts_per_page', 3 )设置posts_per_page参数为 3。
第三部分：query_vars 的优先级和合并
当多个地方都尝试设置同一个 query_vars 参数时，WordPress 会按照一定的优先级进行合并。
一般来说，优先级从低到高如下：
- 默认值：
WP_Query类内部会设置一些默认值。 - URL 参数：URL 中的参数会覆盖默认值。
WP_Query构造函数的参数：构造函数的参数会覆盖 URL 参数。pre_get_posts动作：pre_get_posts动作中设置的参数会覆盖构造函数的参数。
重要提示： 理解这个优先级非常重要，它可以帮助你避免意外的覆盖和冲突。
第四部分：高级技巧：使用 query_vars 进行高级查询
掌握了 query_vars 的基本知识后，我们可以利用它进行一些高级查询，实现更复杂的功能。
-
多重条件查询：可以使用数组来指定多个条件。例如，获取分类 ID 为 1 或 2 的文章：
<?php $args = array( 'cat' => array( 1, 2 ), ); $query = new WP_Query( $args ); ?> -
自定义字段范围查询：可以结合
meta_key、meta_value和meta_compare来实现自定义字段的范围查询。例如，获取价格在 100 到 200 之间的产品：<?php $args = array( 'meta_query' => array( array( 'key' => 'price', 'value' => array( 100, 200 ), 'type' => 'NUMERIC', 'compare' => 'BETWEEN', ), ), 'post_type' => 'product', // 假设 'product' 是你的自定义文章类型 ); $query = new WP_Query( $args ); ?>代码解释：
meta_query是一个数组，用于指定自定义字段的查询条件。key是自定义字段的键名。value是自定义字段的值，这里是一个数组，表示范围。type是自定义字段值的类型，这里是NUMERIC（数字）。compare是比较方式，这里是BETWEEN（介于）。
-
复杂的
meta_query组合：可以使用AND和OR逻辑来组合多个meta_query条件。<?php $args = array( 'meta_query' => array( 'relation' => 'OR', // 使用 OR 逻辑 array( 'key' => 'color', 'value' => 'red', 'compare' => '=', ), array( 'key' => 'size', 'value' => 'large', 'compare' => '=', ), ), ); $query = new WP_Query( $args ); ?>代码解释：
relation指定多个meta_query条件之间的逻辑关系，可以是AND或OR。- 上面的例子表示获取颜色为红色或者尺寸为大的产品。
-
利用
parse_queryaction来预处理复杂查询
parse_queryaction 在WP_Query对象构造完成后，但在实际查询发生前被触发。这个钩子允许你访问和修改已经设置好的query_vars属性，进行更细致的调整。
<?php
/**
* 演示如何使用parse_query action来修改query_vars
* 假设需求：当URL参数中包含`custom_param`时，根据其值进行一些自定义查询
*/
function my_custom_parse_query( $query ) {
// 确保只修改主查询，避免影响后台或其他地方的查询
if ( $query->is_main_query() ) {
// 获取URL参数 `custom_param` 的值
$custom_param = get_query_var( 'custom_param' );
// 检查 `custom_param` 是否存在并且有值
if ( ! empty( $custom_param ) ) {
// 根据 `custom_param` 的值进行不同的操作
switch ( $custom_param ) {
case 'special':
// 例如：只显示标题包含 "Special" 的文章
$query->set( 's', 'Special' ); // 使用 's' 参数进行关键词搜索
break;
case 'featured':
// 例如：只显示自定义字段 `is_featured` 值为 `true` 的文章
$meta_query = array(
array(
'key' => 'is_featured',
'value' => 'true',
'compare' => '=',
),
);
$query->set( 'meta_query', $meta_query );
break;
default:
// 如果 `custom_param` 的值不在预定义的范围内，可以执行默认操作
// 例如：显示所有文章
break;
}
}
}
}
add_action( 'parse_query', 'my_custom_parse_query' );
/**
* 为了使 WordPress 识别 `custom_param` 参数，需要将其添加到 WordPress 的查询变量列表中
*/
function my_custom_query_vars( $vars ) {
$vars[] = 'custom_param';
return $vars;
}
add_filter( 'query_vars', 'my_custom_query_vars' );代码解释:
-
my_custom_parse_query( $query )：这是一个挂载到parse_query钩子的函数。它接收WP_Query对象作为参数，允许你修改查询的参数。 -
get_query_var( 'custom_param' ): 此函数检索 URL 参数custom_param的值。 -
$query->set( 's', 'Special' ): 如果custom_param的值是"special"，这行代码会设置搜索词（s）为 "Special"，从而筛选出标题包含 "Special" 的文章。 -
$query->set( 'meta_query', $meta_query ): 如果custom_param的值是"featured"，这行代码会设置meta_query，筛选出自定义字段is_featured的值为true的文章。 -
my_custom_query_vars( $vars ): 这是一个挂载到query_vars过滤器的函数。它将自定义查询变量custom_param添加到 WordPress 的查询变量列表中，使得 WordPress 能够识别这个参数。
用法示例:
要在 URL 中使用这个自定义查询，你可以构造类似这样的 URL：
http://yourdomain.com/?custom_param=special
或者
http://yourdomain.com/?custom_param=featured
第五部分：调试 query_vars
调试 query_vars 是解决查询问题的关键。以下是一些常用的调试技巧：
-
使用
print_r()或var_dump()输出query_vars：这是最简单直接的方法。在WP_Query对象创建后，立即输出query_vars的内容，可以帮助你了解哪些参数被设置了，以及它们的值是什么。<?php $args = array( 'post_type' => 'post', 'posts_per_page' => 5, ); $query = new WP_Query( $args ); echo '<pre>'; // 格式化输出 print_r( $query->query_vars ); echo '</pre>'; ?> -
使用
WP_DEBUG模式：开启WP_DEBUG模式可以显示一些错误和警告信息，有助于发现潜在的问题。在
wp-config.php文件中，将WP_DEBUG设置为true：<?php define( 'WP_DEBUG', true ); ?> -
使用 Query Monitor 插件：Query Monitor 是一个非常强大的调试插件，可以显示各种查询信息，包括
query_vars、SQL 查询语句、模板文件等等。
总结
WP_Query 的 query_vars 属性是控制 WordPress 查询的核心。掌握它，你就能更灵活地定制查询逻辑，实现各种复杂的功能。希望今天的考古挖掘对你有所帮助！ 记住，实践是检验真理的唯一标准，多动手尝试，才能真正理解 query_vars 的强大之处。
下次再见！