钩子文档

rest_user_query

💡 云策文档标注

概述

rest_user_query 是一个 WordPress REST API 中的过滤器,用于在通过 REST API 查询用户时修改 WP_User_Query 的参数。它允许开发者在执行用户查询前自定义参数。

关键要点

  • 过滤器名称:rest_user_query
  • 用途:过滤 WP_User_Query 参数,适用于 REST API 用户查询
  • 参数:$prepared_args(WP_User_Query 参数数组)和 $request(WP_REST_Request 对象)
  • 引入版本:WordPress 4.7.0
  • 相关函数:在 WP_REST_Users_Controller::get_items() 中使用,用于检索所有用户

代码示例

$prepared_args = apply_filters( 'rest_user_query', $prepared_args, $request );

📄 原文内容

Filters WP_User_Query arguments when querying users via the REST API.

Parameters

$prepared_argsarray
Array of arguments for WP_User_Query.
$requestWP_REST_Request
The REST API request.

Source

$prepared_args = apply_filters( 'rest_user_query', $prepared_args, $request );

Changelog

Version Description
4.7.0 Introduced.