钩子文档

pre_get_users

💡 云策文档标注

概述

pre_get_users 是一个 WordPress 动作钩子,在 WP_User_Query 对象解析之前触发,允许开发者修改查询变量。

关键要点

  • 触发时机:在 WP_User_Query 解析之前执行,此时查询变量尚未转换为 SQL 语句。
  • 参数:传递一个 WP_User_Query 对象(通过引用),开发者可以访问和修改其查询变量。
  • 用途:常用于自定义用户查询逻辑,如添加条件或调整排序。

代码示例

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

注意事项

  • 此钩子自 WordPress 4.0.0 版本引入。
  • 相关函数:WP_User_Query::prepare_query() 用于准备查询变量。

📄 原文内容

Fires before the WP_User_Query has been parsed.

Description

The passed WP_User_Query object contains the query variables, not yet passed into SQL.

Parameters

$queryWP_User_Query
Current instance of WP_User_Query (passed by reference).

Source

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

Changelog

Version Description
4.0.0 Introduced.