WP_Upgrader::release_lock( string $lock_name ): bool
- Since
- 4.5.0
- Source
wp-admin/includes/class-wp-upgrader.php:1101
Compatibility
- WordPress
- since 4.5.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
$lock_namestring- The name of this unique lock.
Return value
bool- True if the lock was successfully released. False on failure.
Performance profile
How much work a call to WP_Upgrader::release_lock() 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
- 6
- Plugin surface
- None
- Called by
- 3
Reads stored settings via delete_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. The body compiles to 6.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
delete_option()called directly - hookthird-party callbacks
do_action()one call below WP_Upgrader::release_lock() - cacheobject cache
wp_cache_set()one call below WP_Upgrader::release_lock()
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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Upgrader::release_lock() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6 | delete_option() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 6 instructions, 6 executed per call, 0 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.
Uses · 1
- delete_option()Removes an option by name. Prevents removal of protected WordPress options.
Used by · 3
- Core_Upgrader::upgrade()Upgrades WordPress core.
- WP_Automatic_Updater::run()Kicks off the background update process, looping through all pending updates.
- WP_Upgrader::create_lock()Creates a lock using WordPress options.
Source code
public static function release_lock( $lock_name ) { return delete_option( $lock_name . '.lock' ); }Changelog
Introduced in 4.5.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 6.9.7 tag, from
src/wp-admin/includes/class-wp-upgrader.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.