pre_set_site_transient_<transient>

Filters the value of a specific site transient before it is set.

Description

apply_filters( 'pre_set_site_transient_<transient>', (mixed) $value, (string) $transient ); 

The dynamic portion(s) of the hook name refer to the transient name.

Parameters (2)

0. $value (mixed)
New value of site transient.
1. $transient (string)
Transient name.

Usage

To run the hook, copy the example below.
  1. $value = apply_filters( 'pre_set_site_transient_{$transient}', $value, $transient ); 
  2.  
  3. if ( !empty( $value ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the pre_set_site_transient_<transient> callback 
  2. function filter_pre_set_site_transient_transient( $value, $transient ) { 
  3. // make filter magic happen here... 
  4. return $value
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "pre_set_site_transient_{$transient}", 'filter_pre_set_site_transient_transient', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "pre_set_site_transient_{$transient}", 'filter_pre_set_site_transient_transient', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/option.php  
  1. $value = apply_filters( "pre_set_site_transient_{$transient}", $value, $transient );