深入理解 WordPress `get_terms_args` 过滤器源码：如何修改 `get_terms()` 函数的查询参数。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，早上好！今天咱们来聊聊WordPress里面一个贼好使的过滤器：get_terms_args。这玩意儿就像个万能遥控器，能让你随心所欲地控制 get_terms() 函数的查询参数。想让你的分类目录显示得更个性？想玩出点新花样？那就得好好掌握它！

啥是 get_terms() 及其它小伙伴？

在深入 get_terms_args 之前，先简单回顾一下它的好基友们。

get_terms(): 这是 WordPress 里面的“分类目录、标签、自定义分类法”查询神器。你想要获取哪些分类目录，排序方式，数量限制等等，都靠它。
分类法 (Taxonomy): 这是 WordPress 用来组织内容的利器。最常见的有“分类目录 (category)” 和 “标签 (post_tag)”，当然你也可以自定义各种分类法。
术语 (Term): 它是分类法里面的具体内容。比如，“新闻”、“科技”、“美食”都是“分类目录”这个分类法里面的术语。一个术语对应一个分类或标签。

get_terms_args 闪亮登场！

get_terms_args 过滤器允许你在 get_terms() 函数执行查询之前，修改它的参数。换句话说，你可以在不修改 WordPress 核心代码的情况下，改变 get_terms() 的行为。这简直就是“优雅”的代名词！

get_terms_args 的工作原理

简单来说，get_terms_args 过滤器接收一个参数数组，这个数组包含了 get_terms() 函数将要使用的查询参数。你可以在你的主题或插件中添加一个函数，使用 add_filter() 挂载到 get_terms_args 过滤器上，然后修改这个参数数组，最后返回修改后的数组。WordPress 会使用你修改后的参数来执行查询。

代码示例：小试牛刀

咱们先来个简单的例子，让大家感受一下 get_terms_args 的威力。假设你想让 get_terms() 函数默认只返回 ID 大于 10 的分类目录。

/**
 * 修改 get_terms() 的查询参数
 *
 * @param array $args 查询参数数组
 * @param array $taxonomies 分类法数组
 * @param array $get_terms_args 原始 get_terms() 函数的参数
 *
 * @return array 修改后的查询参数数组
 */
function my_custom_get_terms_args( $args, $taxonomies, $get_terms_args ) {
  $args['number'] = 5;
  $args['hide_empty'] = false;
  $args['offset'] = 2;

  $args['meta_query'] = array(
    array(
      'key' => 'my_custom_field',
      'value' => 'some_value',
      'compare' => '=',
    ),
  );

  return $args;
}
add_filter( 'get_terms_args', 'my_custom_get_terms_args', 10, 3 );

这段代码做了什么？

定义函数 my_custom_get_terms_args(): 这个函数接收三个参数：
- $args: 即将传递给 get_terms() 函数的参数数组。
- $taxonomies: 包含要查询的分类法名称的数组。
- $get_terms_args: 传递给 get_terms() 函数的原始参数数组。
修改 $args 数组: 在这个例子中，我们设置了number,hide_empty,offset，并且添加了meta_query。
返回修改后的 $args 数组: 务必返回修改后的参数数组，否则 WordPress 将使用原始参数。
挂载到 get_terms_args 过滤器: 使用 add_filter() 函数将 my_custom_get_terms_args() 函数挂载到 get_terms_args 过滤器上。10 是优先级，3 是参数数量。

参数详解：$args 数组

$args 数组可以包含很多参数，常用的参数如下表所示：

参数	类型	描述
`taxonomy`	string/array	要查询的分类法名称。可以是字符串（单个分类法）或数组（多个分类法）。
`orderby`	string	排序方式。可以是 `'name'`（名称）、`'slug'`（别名）、`'term_id'`（术语 ID）、`'id'`（等同于 `'term_id'`)、`'count'`（文章数量）、`'none'`（不排序）、`'parent'`（父级 ID）或者一个 meta key。
`order`	string	排序顺序。可以是 `'ASC'`（升序）或 `'DESC'`（降序）。
`hide_empty`	bool	是否隐藏没有文章的术语。默认为 `true`。
`include`	array	只返回指定 ID 的术语。
`exclude`	array	排除指定 ID 的术语。
`number`	int	返回术语的数量限制。如果设置为 `0`，则返回所有术语。
`offset`	int	从第几个术语开始返回。
`slug`	string/array	只返回指定别名的术语。
`name`	string/array	只返回指定名称的术语。
`search`	string	搜索包含指定字符串的术语。
`fields`	string	返回哪些字段。可以是 `'all'`（返回所有字段）、`'ids'`（只返回 ID）、`'names'`（只返回名称）、`'id=>name'` (返回 ID=>Name 数组)。
`get`	string	控制如何检索术语。可以是 `'all'`（返回所有术语）、`'count'`（只返回术语数量）。
`parent`	int	只返回指定父级 ID 的术语。
`hierarchical`	bool	是否返回分层结构。默认为 `true`。
`child_of`	int	只返回指定术语 ID 的子术语。
`meta_query`	array	用于查询术语元数据的数组。
`name__like`	string	匹配包含指定字符串的名称的术语。
`description__like`	string	匹配包含指定字符串的描述的术语。
`pad_counts`	bool	是否更新父级术语的文章数量。默认为 `false` 。
`cache_domain`	string	用于缓存的域名。默认为 `core`。
`update_term_meta_cache`	bool	是否更新术语元数据缓存。默认为 `true`。

高级技巧：meta_query 元数据查询

meta_query 允许你根据术语的元数据进行查询。这玩意儿相当强大，可以实现很多高级功能。

例如，假设你给每个分类目录添加了一个名为 featured 的自定义字段，用于标记是否为精选分类。你可以使用 meta_query 来只获取精选分类目录。

function my_custom_get_terms_args( $args, $taxonomies, $get_terms_args ) {
  $args['meta_query'] = array(
    array(
      'key'     => 'featured',
      'value'   => '1',
      'compare' => '=',
      'type'    => 'NUMERIC', // 指定数据类型
    ),
  );
  return $args;
}
add_filter( 'get_terms_args', 'my_custom_get_terms_args', 10, 3 );

这段代码中，meta_query 数组包含一个子数组，描述了元数据查询的条件。

key: 元数据的键名，这里是 featured。
value: 要匹配的值，这里是 1。
compare: 比较运算符，这里是 = (等于)。其他常用的运算符包括 != (不等于)、> (大于)、< (小于)、LIKE (包含) 等。
type: 元数据的数据类型。常用的类型包括 STRING、NUMERIC、DATE、BINARY 等。

更复杂的 meta_query：多条件查询

你可以使用多个子数组来组合多个元数据查询条件。

function my_custom_get_terms_args( $args, $taxonomies, $get_terms_args ) {
  $args['meta_query'] = array(
    'relation' => 'AND', // 或者 'OR'
    array(
      'key'     => 'featured',
      'value'   => '1',
      'compare' => '=',
      'type'    => 'NUMERIC',
    ),
    array(
      'key'     => 'priority',
      'value'   => '10',
      'compare' => '>=',
      'type'    => 'NUMERIC',
    ),
  );
  return $args;
}
add_filter( 'get_terms_args', 'my_custom_get_terms_args', 10, 3 );

在这个例子中，我们使用了 relation 参数来指定多个条件之间的关系。'AND' 表示所有条件都必须满足，'OR' 表示只要满足其中一个条件即可。

技巧：根据分类法进行不同的参数设置

get_terms_args 过滤器的第二个参数 $taxonomies 包含了要查询的分类法名称。你可以根据不同的分类法，设置不同的查询参数。

function my_custom_get_terms_args( $args, $taxonomies, $get_terms_args ) {
  if ( in_array( 'category', $taxonomies ) ) {
    // 如果查询的是分类目录
    $args['orderby'] = 'name';
    $args['order']   = 'ASC';
  } elseif ( in_array( 'post_tag', $taxonomies ) ) {
    // 如果查询的是标签
    $args['orderby'] = 'count';
    $args['order']   = 'DESC';
  }
  return $args;
}
add_filter( 'get_terms_args', 'my_custom_get_terms_args', 10, 3 );

这段代码根据分类法名称，分别设置了不同的排序方式和排序顺序。

技巧：根据原始参数进行不同的参数设置

get_terms_args 过滤器的第三个参数 $get_terms_args 包含了传递给 get_terms() 函数的原始参数。你可以根据这些原始参数，设置不同的查询参数。

function my_custom_get_terms_args( $args, $taxonomies, $get_terms_args ) {
  if ( isset( $get_terms_args['number'] ) && $get_terms_args['number'] > 0 ) {
    // 如果原始参数中设置了数量限制
    $args['number'] = $get_terms_args['number'] + 5; // 增加数量限制
  }
  return $args;
}
add_filter( 'get_terms_args', 'my_custom_get_terms_args', 10, 3 );

这段代码根据原始参数中的数量限制，增加了数量限制。

一些注意事项

优先级: 多个函数可以挂载到同一个过滤器上。优先级数字越小，函数执行的越早。确保你的函数在其他函数之前或之后执行，以达到你想要的效果。
参数数量: add_filter() 函数的第四个参数指定了传递给你的函数的参数数量。get_terms_args 过滤器传递三个参数，所以你应该设置为 3。
调试: 如果你的代码没有按预期工作，可以使用 var_dump() 或 error_log() 函数来调试参数数组。
性能: 谨慎使用 meta_query，特别是当你的数据库中有很多术语时。复杂的元数据查询可能会影响性能。

实战案例

按自定义字段排序分类目录: 假设你想按照 my_custom_order 这个自定义字段的值来排序分类目录，可以这样实现：

function my_custom_get_terms_args( $args, $taxonomies, $get_terms_args ) {
    if ( in_array( 'category', $taxonomies ) ) {
        $args['orderby']  = 'meta_value_num'; // 使用 meta_value_num 进行数字排序
        $args['meta_key'] = 'my_custom_order';
        $args['order']    = 'ASC'; // 升序排列
    }
    return $args;
}
add_filter( 'get_terms_args', 'my_custom_get_terms_args', 10, 3 );

根据用户角色限制分类目录显示: 假设你只想让管理员看到某些特殊的分类目录：

function my_custom_get_terms_args( $args, $taxonomies, $get_terms_args ) {
    if ( ! current_user_can( 'manage_options' ) ) { // 如果不是管理员
        $args['exclude'] = array( 1, 2, 3 ); // 排除 ID 为 1, 2, 3 的分类目录
    }
    return $args;
}
add_filter( 'get_terms_args', 'my_custom_get_terms_args', 10, 3 );

缓存优化: 可以通过cache_domain参数来对查询结果进行缓存：

function my_custom_get_terms_args( $args, $taxonomies, $get_terms_args ) {
$args['cache_domain'] = 'my_custom_cache';
return $args;
}
add_filter( 'get_terms_args', 'my_custom_get_terms_args', 10, 3 );

总结

get_terms_args 过滤器是一个非常灵活和强大的工具，可以让你轻松地控制 get_terms() 函数的行为。掌握它，你就可以实现各种各样的自定义功能，让你的 WordPress 站点更加个性化。希望今天的讲解能帮助大家更好地理解和使用这个过滤器。下课！

发表回复 取消回复

发表回复取消回复