How to use delete_site_option action in WordPress

delete_site_option action

Fires after a network option has been deleted.

To use delete_site_option 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 execute_on_delete_site_option_event which takes 2 parameters and we registered using add_action. The first parameter delete_site_option is name of the hook, The second parameter execute_on_delete_site_option_event is name of the function which need to be called, third parameter is the priority of calling the hook if 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 delete_site_option action.

Parameters

Below are the 2 parameters required to use this hook.

• $option : (string) Name of the network option.
• $network_id : (int) ID of the network.

Live Example 1

Below is an example how you can use this hook.

function weplugins_execute_on_delete_site_option_event($option, $network_id){
   //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( "delete_site_option", "weplugins_execute_on_delete_site_option_event" , 10, 2);

Live Example 2

To log the deletion of a network option for debugging purposes:

function weplugins_log_site_option_deletion($option, $network_id){
    error_log("Network option deleted: " . $option . " from network ID: " . $network_id);
}
// add the action
add_action( "delete_site_option", "weplugins_log_site_option_deletion" , 10, 2);

Live Example 3

To remove a hook callback, use the example below.

remove_action( "delete_site_option", "weplugins_execute_on_delete_site_option_event", 10, 2 );

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 or need customization, please Contact Us and we’d be happy to assist you.