钩子文档

parse_site_query

💡 云策文档标注

概述

parse_site_query 是一个 WordPress 动作钩子,在站点查询变量解析后触发。它允许开发者在 WP_Site_Query 实例处理查询参数时执行自定义代码。

关键要点

  • 这是一个动作钩子,在 WP_Site_Query::parse_query() 方法中调用,用于在站点查询变量解析后执行操作。
  • 钩子传递一个参数:$query,即 WP_Site_Query 实例(通过引用传递),开发者可以访问和修改查询对象。
  • 首次引入于 WordPress 4.6.0 版本,与站点查询功能相关。

代码示例

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

注意事项

由于 $query 参数通过引用传递,修改它可能会直接影响后续的查询行为,需谨慎操作以避免意外结果。


📄 原文内容

Fires after the site query vars have been parsed.

Parameters

$queryWP_Site_Query
The WP_Site_Query instance (passed by reference).

Source

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

Changelog

Version Description
4.6.0 Introduced.