Changeset 34497

Timestamp:

09/24/2015 02:34:15 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Mark the optional $upgrader parameter as such and add a description in the DocBlock for Language_Pack_Upgrader::async_upgrade().

See [32655].

See #30989. See #32246.

File:

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

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

@@ -1807 +1807 @@
 
     /**
-     * Asynchronously upgrade language packs after other upgrades have been made.
+     * Asynchronously upgrades language packs after other upgrades have been made.
      *
      * Hooked to the {@see 'upgrader_process_complete'} action by default.
@@ -1813 +1813 @@
      * @since 3.7.0
      * @access public
-     *
      * @static
      *
-     * @param false|WP_Upgrader $upgrader
+     * @param false|WP_Upgrader $upgrader Optional. WP_Upgrader instance or false. If `$upgrader` is
+     *                                    a Language_Pack_Upgrader instance, the method will bail to
+     *                                    avoid recursion. Otherwise unused. Default false.
      */
     public static function async_upgrade( $upgrader = false ) {
@@ -1830 +1831 @@
         }
 
-        // Avoid messing with VCS installs, at least for now.
-        // Noted: this is not the ideal way to accomplish this.
+        /*
+         * Avoid messing with VCS installs, at least for now.
+         * Noted: this is not the ideal way to accomplish this.
+         */
         $check_vcs = new WP_Automatic_Updater;
         if ( $check_vcs->is_vcs_checkout( WP_CONTENT_DIR ) ) {