WordPress.org

Make WordPress Core

Changeset 37558


Ignore:
Timestamp:
05/25/2016 02:44:08 PM (4 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-upgrader.php

    r37550 r37558  
    652652         * Filters the package options before running an update.
    653653         *
     654         * See also {@see 'upgrader_process_complete'}.
     655         *
    654656         * @since 4.3.0
    655657         *
     
    663665         *     @type bool   $abort_if_destination_exists Abort if the Destination directory exists.
    664666         *     @type bool   $is_multi                    Whether the upgrader is running multiple times.
    665          *     @type array  $hook_extra                  Extra hook arguments.
     667         *     @type array  $hook_extra {
     668         *         Extra hook arguments.
     669         *
     670         *         @type string $action               Type of action. Default 'update'.
     671         *         @type string $type                 Type of update process. Accepts 'plugin', 'theme', or 'core'.
     672         *         @type bool   $bulk                 Whether the update process is a bulk update. Default true.
     673         *         @type string $plugin               The base plugin path from the plugins directory.
     674         *         @type string $theme                The stylesheet or template name of the theme.
     675         *         @type string $language_update_type The language pack update type. Accepts 'plugin', 'theme',
     676         *                                            or 'core'.
     677         *         @type object $language_update      The language pack update offer.
     678         *     }
    666679         * }
    667680         */
     
    746759             * Fires when the upgrader process is complete.
    747760             *
     761             * See also {@see 'upgrader_package_options'}.
     762             *
    748763             * @since 3.6.0
    749764             * @since 3.7.0 Added to WP_Upgrader::run().
     
    754769             *     Array of bulk item update data.
    755770             *
    756              *     @type string $action               Type of action. Default 'update'.
    757              *     @type string $type                 Type of update process. Accepts 'plugin', 'theme', or 'core'.
    758              *     @type bool   $bulk                 Whether the update process is a bulk update. Default true.
    759              *     @type string $plugin               The base plugin path from the plugins directory.
    760              *     @type string $theme                The stylesheet or template name of the theme.
    761              *     @type string $language_update_type The language pack update type. Accepts 'plugin', 'theme',
    762              *                                        or 'core'.
    763              *     @type object $language_update      The language pack update offer.
     771             *     @type string $action  Type of action. Default 'update'.
     772             *     @type string $type    Type of update process. Accepts 'plugin', 'theme', or 'core'.
     773             *     @type bool   $bulk    Whether the update process is a bulk update. Default true.
     774             *     @type array  $plugins Array of the basename paths of the plugins' main files.
     775             *     @type array  $themes  The theme slugs.
    764776             * }
    765777             */
Note: See TracChangeset for help on using the changeset viewer.