钩子文档

rest_insert_user

💡 云策文档标注

概述

rest_insert_user 是一个 WordPress 动作钩子,在通过 REST API 创建或更新用户后立即触发。它允许开发者在用户数据被处理时执行自定义操作。

关键要点

  • 触发时机:在 REST API 创建或更新用户后立即执行。
  • 参数:$user(WP_User 对象)、$request(WP_REST_Request 对象)、$creating(布尔值,创建时为 true,更新时为 false)。
  • 用途:常用于扩展用户管理功能,如日志记录、数据同步或自定义验证。
  • 相关函数:与 WP_REST_Users_Controller 中的 create_item() 和 update_item() 方法关联。
  • 版本历史:自 WordPress 4.7.0 版本引入。

代码示例

add_action( 'rest_insert_user', 'my_custom_user_action', 10, 3 );
function my_custom_user_action( $user, $request, $creating ) {
    if ( $creating ) {
        // 用户创建时的自定义逻辑
        error_log( '用户创建: ' . $user->user_login );
    } else {
        // 用户更新时的自定义逻辑
        error_log( '用户更新: ' . $user->user_login );
    }
}

📄 原文内容

Fires immediately after a user is created or updated via the REST API.

Parameters

$userWP_User
Inserted or updated user object.
$requestWP_REST_Request
Request object.
$creatingbool
True when creating a user, false when updating.

Source

do_action( 'rest_insert_user', $user, $request, true );

Changelog

Version Description
4.7.0 Introduced.