How to use clean_taxonomy_cache action in WordPress

clean_taxonomy_cache action

Fires after a taxonomy’s caches have been cleaned.

To use clean_taxonomy_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_taxonomy_cache_event which takes 1 parameter and we registered using add_action. The first parameter clean_taxonomy_cache is the name of the hook, the second parameter execute_on_clean_taxonomy_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_taxonomy_cache action.

Parameters

Below is the 1 parameter required to use this hook:

• $taxonomy: (string) Taxonomy slug.

Live Example 1

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

  function weplugins_execute_on_clean_taxonomy_cache_event($taxonomy){
     // 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.
  }
  // add the action
  add_action("clean_taxonomy_cache", "weplugins_execute_on_clean_taxonomy_cache_event" , 10, 1);
  

Live Example 2

To remove a hook callback, use the example below:

  remove_action("clean_taxonomy_cache", "weplugins_execute_on_clean_taxonomy_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

Another way to implement this hook is as shown below:

  function weplugins_another_clean_taxonomy_cache_callback($taxonomy){
     // Custom functionality for the taxonomy cache clean event.
  }
  // add the action with different priority
  add_action("clean_taxonomy_cache", "weplugins_another_clean_taxonomy_cache_callback" , 20, 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.