钩子文档

delete_user_form

💡 云策文档标注

概述

delete_user_form 是一个 WordPress 动作钩子,在删除用户表单的确认按钮前触发,允许开发者在删除用户时执行自定义操作。

关键要点

  • 触发时机:在删除用户表单的末尾、确认按钮之前执行。
  • 参数:$current_user(WP_User 对象,表示当前用户)和 $user_ids(整数数组,包含待删除用户的 ID)。
  • 版本历史:从 WordPress 4.0.0 引入,4.5.0 版本添加了 $user_ids 参数。

代码示例

do_action( 'delete_user_form', $current_user, $user_ids );

注意事项

  • 此钩子主要用于多站点环境,如 confirm_delete_users() 函数中,用于在删除用户前添加自定义内容或验证。
  • 开发者应确保钩子回调函数正确处理参数,避免影响删除流程。

📄 原文内容

Fires at the end of the delete users form prior to the confirm button.

Parameters

$current_userWP_User
WP_User object for the current user.
$user_idsint[]
Array of IDs for users being deleted.

Source

do_action( 'delete_user_form', $current_user, $user_ids );

Changelog

Version Description
4.5.0 The $user_ids parameter was added.
4.0.0 Introduced.