钩子文档

rest_delete_user

💡 云策文档标注

概述

rest_delete_user 是一个 WordPress 动作钩子,在通过 REST API 删除用户后立即触发。它允许开发者在用户删除操作后执行自定义代码。

关键要点

  • 触发时机:在用户通过 REST API 删除后立即执行。
  • 参数:传递三个参数:$user(WP_User 对象,包含用户数据)、$response(WP_REST_Response 对象,API 返回的响应)、$request(WP_REST_Request 对象,发送到 API 的请求)。
  • 用途:常用于日志记录、清理相关数据或发送通知等后续处理。
  • 版本:从 WordPress 4.7.0 版本开始引入。
  • 相关函数:在 WP_REST_Users_Controller::delete_item() 方法中使用,用于删除单个用户。

📄 原文内容

Fires immediately after a user is deleted via the REST API.

Parameters

$userWP_User
The user data.
$responseWP_REST_Response
The response returned from the API.
$requestWP_REST_Request
The request sent to the API.

Source

do_action( 'rest_delete_user', $user, $response, $request );

Changelog

Version Description
4.7.0 Introduced.