IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Improve documentation for WP_Upgrader::create_lock(), introduced in [36349].

Browse Source 
See #34878. See #35986.

Built from https://develop.svn.wordpress.org/trunk@36821


git-svn-id: http://core.svn.wordpress.org/trunk@36788 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2016-03-03 07:08:25 +00:00
parent e230095225
commit 1dc0a9a5f7
2 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
wp-admin/includes/class-wp-upgrader.php
View File

@@ -752,15 +752,16 @@ class WP_Upgrader {
}
/**
* Create a Lock using WordPress options.
* Creates a lock using WordPress options.
*
* @since 4.5.0
* @access public
* @static
*
* @param string $lock_name The name of this unique lock.
* @param int $release_timeout The duration in seconds to respect an existing lock. Default: 1 hour.
* @return bool
* @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 no longer valid. True otherwise.
*/
public static function create_lock( $lock_name, $release_timeout = null ) {
global $wpdb;
@@ -769,18 +770,18 @@ class WP_Upgrader {
}
$lock_option = $lock_name . '.lock';
// Try to 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 we couldn't create a lock, and there isn't a lock, bail
// 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
// Check to see if the lock is still valid. If not, bail.
if ( $lock_result > ( time() - $release_timeout ) ) {
return false;
}
@@ -791,7 +792,7 @@ class WP_Upgrader {
return WP_Upgrader::create_lock( $lock_name, $release_timeout );
}
// Update the lock, as by this point we've definitely got a lock, just need to fire the actions
// Update the lock, as by this point we've definitely got a lock, just need to fire the actions.
update_option( $lock_option, time() );
return true;