How to use clean_network_cache action in WordPress

clean_network_cache action

Fires immediately after a network has been removed from the object cache.

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

Parameters

Below the 1 parameter is required to use this hook.

• $id: (int) Network ID.

Live Example

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

Example 1: Basic Usage

This is a simple example demonstrating the basic usage of the clean_network_cache hook.

        function weplugins_execute_on_clean_network_cache_event($id){
           // Code to be executed when this action occurs in WordPress.
        }
        // Add the action
        add_action( "clean_network_cache", "weplugins_execute_on_clean_network_cache_event" , 10, 1);
        

Example 2: Logging Network Cache Clear Event

This example logs the network cache clear event with the network ID.

        function weplugins_log_network_cache_clear($id){
           error_log("Network cache cleared for network ID: " . $id);
        }
        // Add the action
        add_action( "clean_network_cache", "weplugins_log_network_cache_clear" , 10, 1);
        

Example 3: Removing a Hook

To remove a hook callback, use the example below.

        // Remove the action
        remove_action( "clean_network_cache", "weplugins_execute_on_clean_network_cache_event", 10, 1 );
        

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