钩子文档

pre_get_sites

💡 云策文档标注

概述

pre_get_sites 是一个 WordPress Hook,在检索站点之前触发,允许开发者修改 WP_Site_Query 查询参数。

关键要点

  • Hook 名称:pre_get_sites
  • 触发时机:在 WP_Site_Query::get_sites() 检索站点之前
  • 参数:$query(WP_Site_Query 实例,通过引用传递)
  • 用途:用于自定义或过滤站点查询逻辑
  • 引入版本:WordPress 4.6.0

代码示例

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

注意事项

  • 参数 $query 是 WP_Site_Query 对象,通过引用传递,可直接修改其属性以影响查询结果。
  • 此 Hook 主要用于多站点环境,用于控制站点列表的检索行为。

📄 原文内容

Fires before sites are retrieved.

Parameters

$queryWP_Site_Query
Current instance of WP_Site_Query (passed by reference).

Source

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

Changelog

Version Description
4.6.0 Introduced.