Changeset 36821 for trunk/src/wp-admin/includes/class-wp-upgrader.php

Timestamp:

03/03/2016 07:07:31 AM (9 years ago)

Author:

DrewAPicture

Message:

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

See #34878. See #35986.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -753 +753 @@
 
     /**
-     * Create a Lock using WordPress options.
+     * Creates a lock using WordPress options.
      *
      * @since 4.5.0
@@ -760 +760 @@
      *
      * @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 ) {
@@ -770 +771 @@
         $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() ) );
 
@@ -776 +777 @@
             $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;
@@ -792 +793 @@
         }
 
-        // 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() );