钩子文档

found_users_query

💡 云策文档标注

概述

found_users_query 是一个 WordPress 过滤器,用于修改 WP_User_Query 实例中 SELECT FOUND_ROWS() 查询的 SQL 字符串。它允许开发者在执行用户查询时自定义获取总行数的逻辑。

关键要点

  • 过滤器名称:found_users_query
  • 作用:过滤 WP_User_Query 实例的 SELECT FOUND_ROWS() 查询
  • 参数:$sqlstring(当前查询的 SQL 字符串)和 $query(当前 WP_User_Query 实例)
  • 相关函数:WP_User_Query::query() 用于执行查询
  • 版本历史:从 3.2.0 引入,5.1.0 添加了 $this 参数

📄 原文内容

Filters SELECT FOUND_ROWS() query for the current WP_User_Query instance.

Parameters

$sqlstring
The SELECT FOUND_ROWS() query for the current WP_User_Query.
$queryWP_User_Query
The current WP_User_Query instance.

Source

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

Changelog

Version Description
5.1.0 Added the $this parameter.
3.2.0 Introduced.