set_site_transient

Set/update the value of a site transient.

Description

set_site_transient( (string) $transient, (mixed) $value, (int) $expiration = 0 ); 

You do not need to serialize values, if the value needs to be serialize, then it will be serialized before it is set.

Parameters (3)

0. $transient (string)
Transient name. Expected to not be SQL-escaped. Must be 40 characters or fewer in length.
1. $value (mixed)
Transient value. Expected to not be SQL-escaped.
2. $expiration — Optional. (int)
Time until expiration in seconds. Default 0 (no expiration).

Usage

  1. if ( !function_exists( 'set_site_transient' ) ) { 
  2.     require_once ABSPATH . WPINC . '/option.php'; 
  3. } 
  4.   
  5. // Transient name. Expected to not be SQL-escaped. Must be 
  6. // 40 characters or fewer in length. 
  7. $transient = ''; 
  8.   
  9. // Transient value. Expected to not be SQL-escaped. 
  10. $value = null; 
  11.   
  12. // Optional. Time until expiration in seconds. Default 0 (no expiration). 
  13. $expiration = -1; 
  14.   
  15. // NOTICE! Understand what this does before running. 
  16. $result = set_site_transient($transient, $value, $expiration); 
  17.     

Defined (1)

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

/wp-includes/option.php  
  1. function set_site_transient( $transient, $value, $expiration = 0 ) { 
  2.  
  3.     /** 
  4.      * Filters the value of a specific site transient before it is set. 
  5.      * 
  6.      * The dynamic portion of the hook name, `$transient`, refers to the transient name. 
  7.      * 
  8.      * @since 3.0.0 
  9.      * @since 4.4.0 The `$transient` parameter was added. 
  10.      * 
  11.      * @param mixed  $value     New value of site transient. 
  12.      * @param string $transient Transient name. 
  13.      */ 
  14.     $value = apply_filters( "pre_set_site_transient_{$transient}", $value, $transient ); 
  15.  
  16.     $expiration = (int) $expiration; 
  17.  
  18.     /** 
  19.      * Filters the expiration for a site transient before its value is set. 
  20.      * 
  21.      * The dynamic portion of the hook name, `$transient`, refers to the transient name. 
  22.      * 
  23.      * @since 4.4.0 
  24.      * 
  25.      * @param int    $expiration Time until expiration in seconds. Use 0 for no expiration. 
  26.      * @param mixed  $value      New value of site transient. 
  27.      * @param string $transient  Transient name. 
  28.      */ 
  29.     $expiration = apply_filters( "expiration_of_site_transient_{$transient}", $expiration, $value, $transient ); 
  30.  
  32.         $result = wp_cache_set( $transient, $value, 'site-transient', $expiration ); 
  33.     } else { 
  34.         $transient_timeout = '_site_transient_timeout_' . $transient; 
  35.         $option = '_site_transient_' . $transient; 
  36.         if ( false === get_site_option( $option ) ) { 
  37.             if ( $expiration ) 
  38.                 add_site_option( $transient_timeout, time() + $expiration ); 
  39.             $result = add_site_option( $option, $value ); 
  40.         } else { 
  41.             if ( $expiration ) 
  42.                 update_site_option( $transient_timeout, time() + $expiration ); 
  43.             $result = update_site_option( $option, $value ); 
  44.         } 
  45.     } 
  46.     if ( $result ) { 
  47.  
  48.         /** 
  49.          * Fires after the value for a specific site transient has been set. 
  50.          * 
  51.          * The dynamic portion of the hook name, `$transient`, refers to the transient name. 
  52.          * 
  53.          * @since 3.0.0 
  54.          * @since 4.4.0 The `$transient` parameter was added 
  55.          * 
  56.          * @param mixed  $value      Site transient value. 
  57.          * @param int    $expiration Time until expiration in seconds. 
  58.          * @param string $transient  Transient name. 
  59.          */ 
  60.         do_action( "set_site_transient_{$transient}", $value, $expiration, $transient ); 
  61.  
  62.         /** 
  63.          * Fires after the value for a site transient has been set. 
  64.          * 
  65.          * @since 3.0.0 
  66.          * 
  67.          * @param string $transient  The name of the site transient. 
  68.          * @param mixed  $value      Site transient value. 
  69.          * @param int    $expiration Time until expiration in seconds. 
  70.          */ 
  71.         do_action( 'setted_site_transient', $transient, $value, $expiration ); 
  72.     } 
  73.     return $result; 
  74. }