钩子文档

the_sites

💡 云策文档标注

概述

the_sites 是一个 WordPress 过滤器钩子,用于在查询站点时修改返回的 WP_Site 对象数组。它允许开发者在获取站点列表前自定义结果。

关键要点

  • the_sites 是一个过滤器钩子,作用于 WP_Site_Query::get_sites() 方法返回的站点数组。
  • 参数包括 $_sites(WP_Site 对象数组)和 $query(WP_Site_Query 实例引用),开发者可以基于这些参数调整查询结果。
  • 此钩子自 WordPress 4.6.0 版本引入,用于增强站点查询的灵活性。

📄 原文内容

Filters the site query results.

Parameters

$_sitesWP_Site[]
An array of WP_Site objects.
$queryWP_Site_Query
Current instance of WP_Site_Query (passed by reference).

Source

$_sites = apply_filters_ref_array( 'the_sites', array( $_sites, &$this ) );

Changelog

Version Description
4.6.0 Introduced.