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
This commit is contained in:
Drew Jaynes 2015-09-24 14:34:15 +00:00
parent 04bb8a07d7
commit ad64ee866b
1 changed files with 8 additions and 5 deletions

View File

@ -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;