delete_transient( string $transient ): bool
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
.
View all references
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;
}
Hooks
-
do_action( 'deleted_transient',
string $transient ) -
Fires after a transient is deleted.
-
do_action( "delete_transient_{$transient}",
string $transient ) -
Fires immediately before a specific transient is deleted.
Changelog
Version | Description |
---|---|
2.8.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Cache invalidation
If data (posts, terms, users, comments, etc.) has been updated, previously cached data, being retrieved from transients, might be invalid.
Flush explicitly corresponding transients using the following action hooks:
NOTE: In some cases you might need to check post status, for example, when you move post to trash or restore it.
Clearing our transient via the edit_term hook