Changeset 51185

Timestamp:

06/19/2021 09:36:01 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct DocBlock formatting for Core_Upgrader::upgrade().

Document the $auto_update_settings parameter of the after_core_auto_updates_settings action.

Follow-up to [49254].

See #52628.

Location:

trunk/src/wp-admin

Files:

• includes/class-core-upgrader.php (modified) (1 diff)
• update-core.php (modified) (1 diff)

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

@@ -49 +49 @@
      * @param object $current Response object for whether WordPress is current.
      * @param array  $args {
-     *        Optional. Arguments for upgrading WordPress core. Default empty array.
-     *
-     *        @type bool $pre_check_md5    Whether to check the file checksums before
-     *                                     attempting the upgrade. Default true.
-     *        @type bool $attempt_rollback Whether to attempt to rollback the chances if
-     *                                     there is a problem. Default false.
-     *        @type bool $do_rollback      Whether to perform this "upgrade" as a rollback.
-     *                                     Default false.
+     *     Optional. Arguments for upgrading WordPress core. Default empty array.
+     *
+     *     @type bool $pre_check_md5    Whether to check the file checksums before
+     *                                  attempting the upgrade. Default true.
+     *     @type bool $attempt_rollback Whether to attempt to rollback the chances if
+     *                                  there is a problem. Default false.
+     *     @type bool $do_rollback      Whether to perform this "upgrade" as a rollback.
+     *                                  Default false.
      * }
      * @return string|false|WP_Error New WordPress version on success, false or WP_Error on failure.

trunk/src/wp-admin/update-core.php

@@ -422 +422 @@
      *
      * @since 5.6.0
+     *
+     * @param array $auto_update_settings {
+     *     Array of core auto-update settings.
+     *
+     *     @type bool $dev   Whether to enable automatic updates for development versions.
+     *     @type bool $minor Whether to enable minor automatic core updates.
+     *     @type bool $major Whether to enable major automatic core updates.
+     * }
      */
     do_action( 'after_core_auto_updates_settings', $auto_update_settings );