delete_transient( string $transient )
Delete a transient.
Parameters
- $transient
-
(Required) Transient name. Expected to not be SQL-escaped.
Return
(bool) true if successful, false otherwise
Source
File: wp-includes/option.php
function delete_transient( $transient ) {
/**
* Fires immediately before a specific transient is deleted.
*
* The dynamic portion of the hook name, `$transient`, refers to the transient name.
*
* @since WP-3.0.0
*
* @param string $transient Transient name.
*/
do_action( "delete_transient_{$transient}", $transient );
if ( wp_using_ext_object_cache() ) {
$result = wp_cache_delete( $transient, 'transient' );
} else {
$option_timeout = '_transient_timeout_' . $transient;
$option = '_transient_' . $transient;
$result = delete_option( $option );
if ( $result )
delete_option( $option_timeout );
}
if ( $result ) {
/**
* Fires after a transient is deleted.
*
* @since WP-3.0.0
*
* @param string $transient Deleted transient name.
*/
do_action( 'deleted_transient', $transient );
}
return $result;
}
Changelog
Version | Description |
---|---|
WP-2.8.0 | Introduced. |