delete_transient() WordPress Function
The delete_transient() function is used to delete a transient value from the database. A transient is a piece of data that is stored in the database for a limited amount of time. This function deletes the transient with the specified name.
delete_transient( string $transient ) #
Deletes a transient.
Parameters
- $transient
(string)(Required)Transient name. Expected to not be SQL-escaped.
Return
(bool) True if the transient was deleted, 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 3.0.0
*
* @param string $transient Transient name.
*/
do_action( "delete_transient_{$transient}", $transient );
if ( wp_using_ext_object_cache() || wp_installing() ) {
$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 3.0.0
*
* @param string $transient Deleted transient name.
*/
do_action( 'deleted_transient', $transient );
}
return $result;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.8.0 | Introduced. |