How to use deleted_site_transient action in WordPress

deleted_site_transient action

Fires after a transient is deleted.

To use deleted_site_transient 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_deleted_site_transient_event which takes 1 parameter and we registered it using add_action. The first parameter deleted_site_transient is the name of the hook, the second parameter execute_on_deleted_site_transient_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 the deleted_site_transient action.

Parameters

Below the 1 parameter is required to use this hook.

• $transient: (string) Deleted transient name.

Live Example 1

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

        function weplugins_execute_on_deleted_site_transient_event($transient){
            // 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_site_transient", "weplugins_execute_on_deleted_site_transient_event" , 10, 1);
    

Live Example 2

To remove a hook callback, use the example below.

        remove_action( "deleted_site_transient", "weplugins_execute_on_deleted_site_transient_event", 10, 1 );
    

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

Live Example 3

Here’s another example to illustrate the usage of this hook in a different scenario.

        function weplugins_log_deleted_transient($transient){
            error_log('Transient deleted: ' . $transient);
        }
        // add the action
        add_action( "deleted_site_transient", "weplugins_log_deleted_transient" , 10, 1);
    

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.