From 62d4798863a071d94cfe7b667ba504ae5f1903dc Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Wed, 25 May 2016 14:45:27 +0000 Subject: [PATCH] Docs: Update hook docs for the `upgrader_package_options` filter and `upgrader_process_complete` action to reflect expected values in the core, language pack, theme, and plugin contexts. Props nextendweb for the initial patch. See [37550]. Fixes #36875. Built from https://develop.svn.wordpress.org/trunk@37558 git-svn-id: http://core.svn.wordpress.org/trunk@37526 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/class-wp-upgrader.php | 30 +++++++++++++++++-------- wp-includes/version.php | 2 +- 2 files changed, 22 insertions(+), 10 deletions(-) diff --git a/wp-admin/includes/class-wp-upgrader.php b/wp-admin/includes/class-wp-upgrader.php index 053b0546a2..42b96b59dc 100644 --- a/wp-admin/includes/class-wp-upgrader.php +++ b/wp-admin/includes/class-wp-upgrader.php @@ -651,6 +651,8 @@ class WP_Upgrader { /** * Filters the package options before running an update. * + * See also {@see 'upgrader_process_complete'}. + * * @since 4.3.0 * * @param array $options { @@ -662,7 +664,18 @@ class WP_Upgrader { * @type bool $clear_working Clear the working resource. * @type bool $abort_if_destination_exists Abort if the Destination directory exists. * @type bool $is_multi Whether the upgrader is running multiple times. - * @type array $hook_extra Extra hook arguments. + * @type array $hook_extra { + * Extra hook arguments. + * + * @type string $action Type of action. Default 'update'. + * @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 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. + * } * } */ $options = apply_filters( 'upgrader_package_options', $options ); @@ -745,6 +758,8 @@ class WP_Upgrader { /** * Fires when the upgrader process is complete. * + * See also {@see 'upgrader_package_options'}. + * * @since 3.6.0 * @since 3.7.0 Added to WP_Upgrader::run(). * @@ -753,14 +768,11 @@ class WP_Upgrader { * @param array $hook_extra { * Array of bulk item update data. * - * @type string $action Type of action. Default 'update'. - * @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 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. + * @type string $action Type of action. Default 'update'. + * @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 array $plugins Array of the basename paths of the plugins' main files. + * @type array $themes The theme slugs. * } */ do_action( 'upgrader_process_complete', $this, $options['hook_extra'] ); diff --git a/wp-includes/version.php b/wp-includes/version.php index 21167f65e9..6a769c49dc 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.6-alpha-37557'; +$wp_version = '4.6-alpha-37558'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.