How to use expiration_of_transient_transient filter in WordPress

expiration_of_transient_transient filter

The dynamic portion of the hook name, $transient, refers to the transient name.

To use expiration_of_transient_transient filter, first you have to register it using add_filter. 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 modify_expiration_of_transient_transient_defaults which takes 3 parameters and we registered using add_filter. The first parameter expiration_of_transient_transient is the name of the hook, the second parameter modify_expiration_of_transient_transient_defaults 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.

Sometime, you have to remove a registered hook so you can use remove_filter to remove expiration_of_transient_transient filter.

Parameters

Below are the 3 parameters required to use this hook:

• $expiration: (int) Time until expiration in seconds. Use 0 for no expiration.
• $value: (mixed) New value of transient.
• $transient: (string) Transient name.

Live Example

Example 1: Basic Usage

Below is an example of how you can use this hook to modify the expiration time of a transient.

  function weplugins_modify_expiration_of_transient_transient_defaults($expiration, $value, $transient) { 
      // Update the $expiration variable according to your website requirements and return this variable. You can modify the $expiration variable conditionally too if you want.
      return $expiration; 
  }
  // Add the filter
  add_filter( "expiration_of_transient_transient", "weplugins_modify_expiration_of_transient_transient_defaults", 10, 3 );
  

Example 2: Conditional Expiration

This example shows how to change the expiration time conditionally based on the transient name.

  function weplugins_modify_expiration_based_on_transient($expiration, $value, $transient) { 
      if($transient == 'special_transient') {
          $expiration = 3600; // 1 hour
      }
      return $expiration; 
  }
  // Add the filter
  add_filter( "expiration_of_transient_transient", "weplugins_modify_expiration_based_on_transient", 10, 3 );
  

Example 3: Removing a Hook

To remove a hook callback, use the example below:

  remove_filter( "expiration_of_transient_transient", "weplugins_modify_expiration_of_transient_transient_defaults", 10, 3 );
  

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

Contact Us

If you need customization or are having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.