钩子文档

get_terms

💡 云策文档标注

概述

get_terms 是一个 WordPress 过滤器钩子,用于在检索到分类法术语后对结果进行过滤。它允许开发者修改或扩展 get_terms() 函数返回的术语数组。

关键要点

  • 过滤器名称:get_terms,用于过滤通过 get_terms() 或 WP_Term_Query 检索到的术语。
  • 参数:$terms(术语数组)、$taxonomies(分类法数组或 null)、$args(get_terms() 参数数组)、$term_query(WP_Term_Query 对象)。
  • 用途:常用于自定义术语查询结果,例如排序、筛选或添加额外数据。
  • 版本历史:从 WordPress 2.3.0 引入,4.6.0 版本添加了 $term_query 参数。

注意事项

  • 使用此过滤器时需谨慎,避免影响其他插件或主题的功能。
  • 参数 $taxonomies 可能为 null,需在代码中处理此情况。
  • 参考 WP_Term_Query::__construct() 了解 $args 的详细参数选项。

📄 原文内容

Filters the found terms.

Parameters

$termsarray
Array of found terms.
$taxonomiesarray|null
An array of taxonomies if known.
$argsarray
An array of get_terms() arguments.

More Arguments from get_terms( … $args )

Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments.

$term_queryWP_Term_Query
The WP_Term_Query object.

Source

return apply_filters( 'get_terms', $terms, $term_query->query_vars['taxonomy'], $term_query->query_vars, $term_query );

Changelog

Version Description
4.6.0 Added the $term_query parameter.
2.3.0 Introduced.