From ad64ee866bd293e9e6f421aad95cbd5e40600abc Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 24 Sep 2015 14:34:15 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@34497 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-upgrader.php | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/wp-admin/includes/class-wp-upgrader.php b/src/wp-admin/includes/class-wp-upgrader.php index 91966a74f2..e9bb79e845 100644 --- a/src/wp-admin/includes/class-wp-upgrader.php +++ b/src/wp-admin/includes/class-wp-upgrader.php @@ -1806,16 +1806,17 @@ class Language_Pack_Upgrader extends WP_Upgrader { public $bulk = true; /** - * 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. * * @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 ) { // Avoid recursion. @@ -1829,8 +1830,10 @@ class Language_Pack_Upgrader extends WP_Upgrader { return; } - // 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 ) ) { return;