钩子文档

rest_pre_insert_user

💡 云策文档标注

概述

rest_pre_insert_user 是一个 WordPress REST API 钩子,用于在通过 REST API 插入用户数据之前过滤用户对象。它允许开发者在用户创建或更新时修改准备的数据。

关键要点

  • 这是一个过滤器钩子,应用于 REST API 用户插入操作前。
  • 接收两个参数:$prepared_user(用户对象)和 $request(WP_REST_Request 对象)。
  • 在 WP_REST_Users_Controller::prepare_item_for_database() 方法中被调用,用于准备用户数据。
  • 从 WordPress 4.7.0 版本开始引入。

📄 原文内容

Filters user data before insertion via the REST API.

Parameters

$prepared_userobject
User object.
$requestWP_REST_Request
Request object.

Source

return apply_filters( 'rest_pre_insert_user', $prepared_user, $request );

Changelog

Version Description
4.7.0 Introduced.