How to use deleted_blog action in WordPress

deleted_blog action

Fires after the site is deleted from the network.

To use deleted_blog 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_blog_event which takes 2 parameters and we registered using add_action. The first parameter deleted_blog is the name of the hook, The second parameter weplugins_execute_on_deleted_blog_event is the name of the function which needs to be called, 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_blog action.

Parameters

Below are the 2 parameters required to use this hook.

• $site_id : (int) The site ID.
• $drop : (bool) True if site’s tables should be dropped. Default false.

Live Example 1

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

function weplugins_execute_on_deleted_blog_event($site_id, $drop){
   //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_blog", "weplugins_execute_on_deleted_blog_event", 10, 2);

To remove a hook callback, use the example below.

remove_action("deleted_blog", "weplugins_execute_on_deleted_blog_event", 10, 2);

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

Live Example 2

Here’s another way to log when a blog is deleted:

function weplugins_log_deleted_blog_event($site_id, $drop){
   error_log("Site ID $site_id has been deleted. Drop: " . ($drop ? 'Yes' : 'No'));
}
// add the action
add_action("deleted_blog", "weplugins_log_deleted_blog_event", 10, 2);

Live Example 3

Example to perform custom cleanup tasks after blog deletion:

function weplugins_custom_cleanup_after_blog_deletion($site_id, $drop){
   // Perform custom cleanup tasks like deleting custom tables or files related to the site.
   // Example: delete_custom_site_files($site_id);
}
// add the action
add_action("deleted_blog", "weplugins_custom_cleanup_after_blog_deletion", 10, 2);