delete_site_transient

Delete a site transient.

Description

delete_site_transient( (string) $transient ); 

Parameters (1)

0. $transient (string)
Transient name. Expected to not be SQL-escaped.

Usage

  1. if ( !function_exists( 'delete_site_transient' ) ) { 
  2.     require_once ABSPATH . WPINC . '/option.php'; 
  3. } 
  4.   
  5. // Transient name. Expected to not be SQL-escaped. 
  6. $transient = ''; 
  7.   
  8. // NOTICE! Understand what this does before running. 
  9. $result = delete_site_transient($transient); 
  10.     

Defined (1)

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

/wp-includes/option.php  
  1. function delete_site_transient( $transient ) { 
  2.  
  3.     /** 
  4.      * Fires immediately before a specific site transient is deleted. 
  5.      * 
  6.      * The dynamic portion of the hook name, `$transient`, refers to the transient name. 
  7.      * 
  8.      * @since 3.0.0 
  9.      * 
  10.      * @param string $transient Transient name. 
  11.      */ 
  12.     do_action( "delete_site_transient_{$transient}", $transient ); 
  13.  
  15.         $result = wp_cache_delete( $transient, 'site-transient' ); 
  16.     } else { 
  17.         $option_timeout = '_site_transient_timeout_' . $transient; 
  18.         $option = '_site_transient_' . $transient; 
  19.         $result = delete_site_option( $option ); 
  20.         if ( $result ) 
  21.             delete_site_option( $option_timeout ); 
  22.     } 
  23.     if ( $result ) { 
  24.  
  25.         /** 
  26.          * Fires after a transient is deleted. 
  27.          * 
  28.          * @since 3.0.0 
  29.          * 
  30.          * @param string $transient Deleted transient name. 
  31.          */ 
  33.     } 
  34.  
  35.     return $result; 
  36. }