Changeset 37558

Timestamp:

05/25/2016 02:44:08 PM (9 years ago)

Author:

DrewAPicture

Message:

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.

File:

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

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

@@ -652 +652 @@
          * Filters the package options before running an update.
          *
+         * See also {@see 'upgrader_process_complete'}.
+         *
          * @since 4.3.0
          *
@@ -663 +665 @@
          *     @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.
+         *     }
          * }
          */
@@ -746 +759 @@
              * 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().
@@ -754 +769 @@
              *     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.
              * }
              */