Docs: Fix the hook doc for `upgrader_process_complete` to notate all values that might be present in the `hook_extra` array in the various update contexts.

h/t Nextendweb.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@37550 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-05-24 17:51:06 +00:00
parent 5de41748d3
commit 4908e2b035
1 changed files with 10 additions and 5 deletions

View File

@ -750,16 +750,21 @@ class WP_Upgrader {
* *
* @param WP_Upgrader $this WP_Upgrader instance. In other contexts, $this, might be a * @param WP_Upgrader $this WP_Upgrader instance. In other contexts, $this, might be a
* Theme_Upgrader, Plugin_Upgrader or Core_Upgrade instance. * Theme_Upgrader, Plugin_Upgrader or Core_Upgrade instance.
* @param array $data { * @param array $hook_extra {
* Array of bulk item update data. * Array of bulk item update data.
* *
* @type string $action Type of action. Default 'update'. * @type string $action Type of action. Default 'update'.
* @type string $type Type of update process. Accepts 'plugin', 'theme', or 'core'. * @type string $type Type of update process. Accepts 'plugin', 'theme', or 'core'.
* @type bool $bulk Whether the update process is a bulk update. Default true. * @type bool $bulk Whether the update process is a bulk update. Default true.
* @type array $packages Array of plugin, theme, or core packages to update. * @type string $plugin The base plugin path from the plugins directory.
* @type string $theme The stylesheet or template name of the theme.
* @type string $language_update_type The language pack update type. Accepts 'plugin', 'theme',
* or 'core'.
* @type object $language_update The language pack update offer.
* } * }
*/ */
do_action( 'upgrader_process_complete', $this, $options['hook_extra'] ); do_action( 'upgrader_process_complete', $this, $options['hook_extra'] );
$this->skin->footer(); $this->skin->footer();
} }