delete_site_transient( string $transient ): bool
- Since
- 2.9.0
- Source
wp-includes/option.php:2511
Compatibility
- WordPress
- since 2.9.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$transientstring- Transient name. Expected to not be SQL-escaped.
Return value
bool- True if the transient was deleted, false otherwise.
Performance profile
How much work a call to delete_site_transient() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Moderate
- Scaling
- Constant
- Instructions
- 17–28
- Plugin surface
- 2 hooks
- Called by
- 9
Reads stored settings via delete_site_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 34.
Third-party callbacks on 'delete_site_transient_{$transient}', 'deleted_site_transient' run inside this call, and their cost is not bounded by anything here.
9 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()called directly - cacheobject cache
wp_cache_delete()called directly - optionnetwork option
delete_site_option()called directly
Further down the call graph this can also reach serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 7 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost delete_site_transient() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
wp_using_ext_object_cache() | 17 | do_action(), wp_using_ext_object_cache(), wp_cache_delete() |
!wp_using_ext_object_cache() && !wp_installing() | 20 | do_action(), wp_using_ext_object_cache(), wp_installing(), delete_site_option() |
!wp_using_ext_object_cache() && wp_installing() | 20 | do_action(), wp_using_ext_object_cache(), wp_installing(), wp_cache_delete() |
wp_using_ext_object_cache() | 21 | do_action(), wp_using_ext_object_cache(), wp_cache_delete(), do_action() |
!wp_using_ext_object_cache() && !wp_installing() | 24 | do_action(), wp_using_ext_object_cache(), wp_installing(), delete_site_option(), delete_site_option() |
!wp_using_ext_object_cache() && wp_installing() | 24 | do_action(), wp_using_ext_object_cache(), wp_installing(), wp_cache_delete(), do_action() |
!wp_using_ext_object_cache() && !wp_installing() | 28 | do_action(), wp_using_ext_object_cache(), wp_installing(), delete_site_option(), delete_site_option(), do_action() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 34 instructions, 17–28 executed per call, 4 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 2
2 hooks fire while delete_site_transient() runs, in this order:
- do_action( delete_site_transient_{$transient} )actionline 2522 (+11 into the body)
Fires immediately before a specific site transient is deleted.
- do_action( deleted_site_transient )actionline 2545 (+34 into the body)
Fires after a transient is deleted.
Uses · 5
- do_action()Calls the callback functions that have been added to an action hook.
- wp_using_ext_object_cache()Toggles `$_wp_using_ext_object_cache` on and off without directly touching global.
- wp_installing()Checks or sets whether WordPress is in "installation" mode.
- wp_cache_delete()Removes the cache contents matching key and group.
- delete_site_option()Removes an option by name for the current network.
Used by · 9
- Core_Upgrader::upgrade()Upgrades WordPress core.
- WP_Feed_Cache_Transient::unlink()Deletes transients.
- WP_Theme::delete_pattern_cache()Clears block pattern cache.
- delete_theme()Removes a theme.
- install_plugin_install_status()Determines the status we can perform on a plugin.
- update_core()Upgrades the core of WordPress.
- wp_clean_plugins_cache()Clears the plugins cache used by get_plugins() and by default, the plugin updates cache.
- wp_clean_themes_cache()Clears the cache held by get_theme_roots() and WP_Theme.
- wp_clean_update_cache()Clears existing update caches for plugins, themes, and core.
Source code
function delete_site_transient( $transient ) { /** * Fires immediately before a specific site 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_site_transient_{$transient}", $transient ); if ( wp_using_ext_object_cache() || wp_installing() ) { $result = wp_cache_delete( $transient, 'site-transient' ); } else { $option_timeout = '_site_transient_timeout_' . $transient; $option = '_site_transient_' . $transient; $result = delete_site_option( $option ); if ( $result ) { delete_site_option( $option_timeout ); } } if ( $result ) { /** * Fires after a transient is deleted. * * @since 3.0.0 * * @param string $transient Deleted transient name. */ do_action( 'deleted_site_transient', $transient ); } return $result;}Changelog
Introduced in 2.9.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/option.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.