How to use deleted_user action in WordPress

deleted_user action

Fires immediately after a user is deleted from the database.

To use deleted_user action, first you have to register it using add_action. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_execute_on_deleted_user_event which takes 3 parameters and we registered using add_action. The first parameter deleted_user is the name of the hook, the second parameter weplugins_execute_on_deleted_user_event is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_action to remove deleted_user action.

Parameters

Below are the 3 parameters required to use this hook.

• $id: (int) ID of the deleted user.
• $reassign: (int|null) ID of the user to reassign posts and links to. Default null, for no reassignment.
• $user: (WP_User) WP_User object of the deleted user.

Live Example

do_action( 'deleted_user', int $id, int|null $reassign, WP_User $user )

Below is an example of how you can use this hook.

Example 1: Basic Usage

This example demonstrates basic usage of the deleted_user action.

  function weplugins_execute_on_deleted_user_event($id, $reassign, $user){
    // You can write code here to be executed when this action occurs in WordPress.
    // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
  }
  // add the action
  add_action( "deleted_user", "weplugins_execute_on_deleted_user_event" , 10, 3);
  

Example 2: Logging Deleted User Information

This example logs the information of the deleted user for auditing purposes.

  function weplugins_log_deleted_user($id, $reassign, $user){
    error_log('User Deleted: ' . print_r($user, true));
  }
  // add the action
  add_action( "deleted_user", "weplugins_log_deleted_user" , 10, 3);
  

Example 3: Reassigning Posts

This example reassigns posts from the deleted user to another user.

  function weplugins_reassign_posts($id, $reassign, $user){
    if($reassign){
      // Code to reassign posts to another user
    }
  }
  // add the action
  add_action( "deleted_user", "weplugins_reassign_posts" , 10, 3);
  

To remove a hook callback, use the example below.

  remove_action( "deleted_user", "weplugins_execute_on_deleted_user_event", 10, 3 );
  

Please make sure to provide the same callback function name, priority and number of arguments while removing the hook callback.

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.