当前浏览:首页 / WordPress钩子 / get_terms

apply_filters( 'get_terms', array $terms, array|null $taxonomies, array $args, WP_Term_Query $term_query )

过滤找到的分类项(term)

term 分类项more...


参数

$termsarray
找到的分类项(term)数组。
$taxonomiesarray|null
一组已知的分类模式的数组。
$argsarray
get_terms()参数的数组。

更多参数来自:get_terms( ... $args )

分类项(term)查询参数的数组或查询字符串。

  • taxonomy string|string[]
    分类模式的名称或其名称数组,结果应限于此。
  • object_ids int|int[]
    对象ID或对象ID数组。结果将限于与这些对象相关的分类项。
  • orderby string
    分类项的排序依据字段,接受:

    • 分类项字段('name''slug''term_group''term_id''id''description''parent''term_order')。除非$object_ids不为空,否则'term_order'的处理方式与'term_id'相同。
    • 'count'使用与该分类项相关联的对象的数量。
    • 'include'以匹配$include参数的'order'
    • 'slug__in'以匹配$slug参数的'order'
    • 'meta_value'
    • 'meta_value_num'
    • $meta_key的值。
    • $meta_query的数组键。
    • 'none'忽略ORDER BY子句。

    默认'name'

  • order string
    是否按升序或降序排列分类项。
    接受'ASC'(升序)或'DESC'(降序)。
    默认'ASC'
  • hide_empty bool|int
    是否隐藏未分配给任何文章的分类项。接受1|true0|false。默认1|true
  • include int[]|string
    要包含的分类项ID的数组或以逗号/空格分隔的字符串。
    默认空数组。
  • exclude int[]|string
    要排除的分类项ID的数组或以逗号/空格分隔的字符串。
    如果$include为非空,则忽略$exclude
    默认为空数组。
  • exclude_tree int[]|string
    要排除的分类项ID的数组或以逗号/空格分隔的字符串及其所有后代分类项。如果$include为非空,则忽略$exclude_tree。默认空数组。
  • number int|string
    要返回的最大分类项数量。接受''|0(全部)或任何正数。默认''|0(全部)。请注意,当$number$object_ids.
    结合时,可能无法返回准确的结果。有关详细信息,请参阅#41796。
  • offset int
    用于抵消分类项查询的数字。
  • fields string
    要查询的分类项字段,接受:

    • 'all' 返回一个完整的分类项对象数组 (WP_Term[])
    • 'all_with_object_id' 返回一个带有 'object_id' 参数的分类项对象数组 (WP_Term[]). 只有当 $object_ids 参数被填入时有效
    • 'ids' 返回分类项的ID数组 (int[])
    • 'tt_ids' 返回分类项的分类模式的ID数组 (int[])
    • 'names' 返回分类项的名称数组 (string[])
    • 'slugs' 返回分类项的slug数组 (string[])
    • 'count' 返回所匹配分类项的数量 (int)
    • 'id=>parent' 返回一个父级分类项ID的关联数组,以分类项ID为键 (int[])
    • 'id=>name' 返回一个分类项名称的关联数组,以分类项ID为键 (string[])
    • 'id=>slug' 返回一个分类项slug的关联数组,以分类项ID为键 (string[])

    默认 'all'

  • count bool
    是否返回分类项计数。如果为true,将优先于$fields。默认值为false。
  • name string|string[]
    要返回的分类项的名称或名称数组
  • slug string|string[]
    要返回的分类项的slug或slug数组
  • term_taxonomy_id int|int[]
    查询分类项时要匹配的分类模式ID或其ID数组。
  • hierarchical bool
    是否包含具有非空后代的分类项(即使$hide_empty设置为true)。默认为true。
  • search string
    搜索条件以匹配分类项。将在前后使用通配符进行SQL格式化。
  • name__like string
    检索条件为LIKE $name__like的分类项。
  • description__like string
    检索描述为LIKE $description__like的分类项。
  • pad_counts bool
    是否在每个分类项的“count”对象变量的数量中填充分类项的子项的数量。默认值为false。
  • get string
    是否返回分类项而不考虑祖先或分类项是否为空。接受'all'''(禁用)。默认''
  • child_of int
    要检索其子分类项的分类项ID。如果传递了多个分类模式,则忽略$child_of。默认值为0。
  • parent int
    检索直系子项的父分类项ID
  • childless bool
    True将结果限制为没有子项的分类项。
    此参数对非层级分类模式没有影响。
    默认值为false。
  • cache_domain string
    将此查询存储在对象缓存中时要生成的唯一缓存键。默认'core'
  • update_term_meta_cache bool
    是否为匹配的分类项设置meta缓存。默认为true。
  • meta_key string|string[]
    要筛选的一个或多个meta键
  • meta_value string|string[]
    要筛选的一个或多个meta值。
  • meta_compare string
    MySQL运算符,用于比较meta值。
    请参见WP_Meta_Query::__construct()以获取接受值和默认值。
  • meta_compare_key string
    MySQL运算符,用于比较meta-key.
    参见 WP_Meta_Query::__construct()的接受值和默认值。
  • meta_type string
    meta_value列将被CAST用于比较的MySQL数据类型。
    有关接受值和默认值,请参阅WP_Meta_Query::__construct()
  • meta_type_key string
    meta_key列将被CAST用于比较的MySQL数据类型。
    有关接受值和默认值,请参阅WP_Meta_Query::__construct()
  • meta_query array
    WP_Meta_Query参数的关联数组.
    有关接受的值,请参见WP_Meta_Query::__construct()
$term_queryWP_Term_Query
WP_Term_Query对象。


源码

查看源码 官方文档


更新日志

版本描述
4.6.0添加了$term_query参数。
2.3.0开始引入