钩子文档

pre_get_terms

💡 云策文档标注

概述

pre_get_terms 是一个 WordPress 动作钩子,在检索分类法术语之前触发,允许开发者修改 WP_Term_Query 实例以自定义查询行为。

关键要点

  • pre_get_terms 钩子在 WP_Term_Query::get_terms() 方法中调用,用于在检索术语前执行自定义代码。
  • 该钩子传递一个参数:$query,即 WP_Term_Query 实例的引用,开发者可以修改其属性来调整查询条件。
  • pre_get_terms 从 WordPress 4.6.0 版本开始引入,是处理分类法术语查询的重要钩子。

代码示例

do_action_ref_array( 'pre_get_terms', array( &$this ) );

注意事项

使用 pre_get_terms 钩子时,应确保对 WP_Term_Query 实例的修改不会导致意外行为,并注意性能影响。


📄 原文内容

Fires before terms are retrieved.

Parameters

$queryWP_Term_Query
Current instance of WP_Term_Query (passed by reference).

Source

do_action_ref_array( 'pre_get_terms', array( &$this ) );

Changelog

Version Description
4.6.0 Introduced.