How to use clean_page_cache action in WordPress

When working with WordPress, hooks are a lifesaver, right? They allow us to connect custom functions to WordPress events seamlessly. One such hook is the clean_page_cache action, which triggers right after a page’s cache is cleaned. Let’s explore how you can utilize this hook effectively in your WordPress projects.

clean_page_cache Action Hook

The clean_page_cache action fires immediately after the cache for a given page is cleaned. To use this hook, you’ll first need to register it using add_action. You can place this code in the functions.php file of your active theme or in a custom WordPress plugin. At WePlugins, we recommend creating a custom plugin for such hooks, ensuring your changes remain intact even after theme updates.

Example 1: Basic Hook Usage

Here’s a basic example of how you can use the clean_page_cache hook. This snippet defines a function weplugins_execute_on_clean_page_cache_event that will run whenever a page’s cache is cleaned.

    function weplugins_execute_on_clean_page_cache_event($post_id){
       // Custom functionality for when the cache is cleaned
    }
    add_action( "clean_page_cache", "weplugins_execute_on_clean_page_cache_event", 10, 1 );
    

Example 2: Removing a Hook

If you need to remove a previously registered hook, you can use remove_action. Ensure you provide the same callback function name, priority, and number of arguments as used in add_action.

    remove_action( "clean_page_cache", "weplugins_execute_on_clean_page_cache_event", 10, 1 );
    

Example 3: Custom Cache Logic

This example demonstrates adding custom logic during the cache cleaning process. Maybe you want to log the cache clearing events or trigger another process.

    function weplugins_custom_cache_logic($post_id){
       // Log cache clearing or trigger another process
    }
    add_action( "clean_page_cache", "weplugins_custom_cache_logic", 15, 1 );
    

Parameters

Below is the required parameter to use this hook:

• $post_id : (int) Post ID.