钩子文档

found_sites_query

💡 云策文档标注

概述

本文档介绍 WordPress 中的 found_sites_query 过滤器,用于修改检索找到站点数量的 SQL 查询。该过滤器在 WP_Site_Query 类中使用,影响分页相关属性的计算。

关键要点

  • found_sites_query 是一个过滤器,允许开发者自定义用于获取找到站点数量的 SQL 查询字符串。
  • 默认查询为 'SELECT FOUND_ROWS()',用于在有限制子句的查询中计算总站点数。
  • 该过滤器在 WP_Site_Query::set_found_sites() 方法中调用,用于设置 found_sites 和 max_num_pages 属性。
  • 自 WordPress 4.6.0 版本引入,属于核心功能的一部分。

代码示例

$found_sites_query = apply_filters( 'found_sites_query', 'SELECT FOUND_ROWS()', $this );

📄 原文内容

Filters the query used to retrieve found site count.

Parameters

$found_sites_querystring
SQL query. Default ‘SELECT FOUND_ROWS()’.
$site_queryWP_Site_Query
The WP_Site_Query instance.

Source

$found_sites_query = apply_filters( 'found_sites_query', 'SELECT FOUND_ROWS()', $this );

Changelog

Version Description
4.6.0 Introduced.