Summery Summery
Creates a lock using WordPress options.
Syntax Syntax
Parameters Parameters
- $lock_name
-
(Required) The name of this unique lock.
- $release_timeout
-
(Optional) The duration in seconds to respect an existing lock. Default: 1 hour.
Default value: null
Return Return
(bool) False if a lock couldn't be created or if the lock is still valid. True otherwise.
Source Source
File: wp-admin/includes/class-wp-upgrader.php
* * @param string $lock_name The name of this unique lock. * @param int $release_timeout Optional. The duration in seconds to respect an existing lock. * Default: 1 hour. * @return bool False if a lock couldn't be created or if the lock is still valid. True otherwise. */ public static function create_lock( $lock_name, $release_timeout = null ) { global $wpdb; if ( ! $release_timeout ) { $release_timeout = HOUR_IN_SECONDS; } $lock_option = $lock_name . '.lock'; // Try to lock. $lock_result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` ( `option_name`, `option_value`, `autoload` ) VALUES (%s, %s, 'no') /* LOCK */", $lock_option, time() ) ); if ( ! $lock_result ) { $lock_result = get_option( $lock_option ); // If a lock couldn't be created, and there isn't a lock, bail. if ( ! $lock_result ) { return false; } // Check to see if the lock is still valid. If it is, bail. if ( $lock_result > ( time() - $release_timeout ) ) { return false; } // There must exist an expired lock, clear it and re-gain it. WP_Upgrader::release_lock( $lock_name ); return WP_Upgrader::create_lock( $lock_name, $release_timeout ); }
Advertisement
Changelog Changelog
Version | Description |
---|---|
4.5.0 | Introduced. |