How to use clean_attachment_cache action in WordPress

clean_attachment_cache action

Fires after the given attachment’s cache is cleaned.

To use clean_attachment_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 execute_on_clean_attachment_cache_event which takes 1 parameter and we registered using add_action. The first parameter clean_attachment_cache is the name of the hook, the second parameter execute_on_clean_attachment_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_attachment_cache action.

Parameters

Below the 1 parameter is required to use this hook.

• $id: (int) Attachment ID.

Live Example 1: Basic Usage

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

    function weplugins_execute_on_clean_attachment_cache_event($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("clean_attachment_cache", "weplugins_execute_on_clean_attachment_cache_event", 10, 1);
    

Live Example 2: Removing the Hook

To remove a hook callback, use the example below.

    remove_action("clean_attachment_cache", "weplugins_execute_on_clean_attachment_cache_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: Logging Attachment Cache Clearance

In this example, we log a message whenever an attachment cache is cleared.

    function weplugins_log_clean_attachment_cache_event($id) {
        error_log("Attachment cache cleared for ID: " . $id);
    }
    add_action("clean_attachment_cache", "weplugins_log_clean_attachment_cache_event", 10, 1);