钩子文档

rest_prepare_user

💡 云策文档标注

概述

rest_prepare_user 是一个 WordPress REST API 过滤器,用于修改从 REST API 返回的用户数据。它允许开发者在用户数据被发送到客户端前进行自定义处理。

关键要点

  • 过滤器名称:rest_prepare_user
  • 参数:$response(WP_REST_Response 对象)、$user(WP_User 对象)、$request(WP_REST_Request 对象)
  • 用途:过滤或修改 REST API 返回的用户数据
  • 相关函数:WP_REST_Users_Controller::prepare_item_for_response()
  • 引入版本:WordPress 4.7.0

代码示例

return apply_filters( 'rest_prepare_user', $response, $user, $request );

📄 原文内容

Filters user data returned from the REST API.

Parameters

$responseWP_REST_Response
The response object.
$userWP_User
User object used to create response.
$requestWP_REST_Request
Request object.

Source

return apply_filters( 'rest_prepare_user', $response, $user, $request );

Changelog

Version Description
4.7.0 Introduced.