Changeset 49028

Timestamp:

09/21/2020 04:44:35 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Correct the indentation for some array type docs.

See #50768

Location:

trunk/src

Files:

• wp-admin/includes/class-core-upgrader.php (modified) (1 diff)
• wp-includes/functions.php (modified) (1 diff)
• wp-includes/ms-functions.php (modified) (1 diff)
• wp-includes/user.php (modified) (2 diffs)

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-includes/functions.php

@@ -7073 +7073 @@
      *
      * @param array $email_change_email {
-     *            Used to build wp_mail().
-     *
-     *            @type string $to      The intended recipient.
-     *            @type string $subject The subject of the email.
-     *            @type string $message The content of the email.
-     *                The following strings have a special meaning and will get replaced dynamically:
-     *                - ###OLD_EMAIL### The old site admin email address.
-     *                - ###NEW_EMAIL### The new site admin email address.
-     *                - ###SITENAME###  The name of the site.
-     *                - ###SITEURL###   The URL to the site.
-     *            @type string $headers Headers.
-     *        }
+     *     Used to build wp_mail().
+     *
+     *     @type string $to      The intended recipient.
+     *     @type string $subject The subject of the email.
+     *     @type string $message The content of the email.
+     *         The following strings have a special meaning and will get replaced dynamically:
+     *         - ###OLD_EMAIL### The old site admin email address.
+     *         - ###NEW_EMAIL### The new site admin email address.
+     *         - ###SITENAME###  The name of the site.
+     *         - ###SITEURL###   The URL to the site.
+     *     @type string $headers Headers.
+     * }
      * @param string $old_email The old site admin email address.
      * @param string $new_email The new site admin email address.

trunk/src/wp-includes/ms-functions.php

@@ -2836 +2836 @@
      *
      * @param array $email_change_email {
-     *            Used to build wp_mail().
-     *
-     *            @type string $to      The intended recipient.
-     *            @type string $subject The subject of the email.
-     *            @type string $message The content of the email.
-     *                The following strings have a special meaning and will get replaced dynamically:
-     *                - ###OLD_EMAIL### The old network admin email address.
-     *                - ###NEW_EMAIL### The new network admin email address.
-     *                - ###SITENAME###  The name of the network.
-     *                - ###SITEURL###   The URL to the site.
-     *            @type string $headers Headers.
-     *        }
+     *     Used to build wp_mail().
+     *
+     *     @type string $to      The intended recipient.
+     *     @type string $subject The subject of the email.
+     *     @type string $message The content of the email.
+     *         The following strings have a special meaning and will get replaced dynamically:
+     *         - ###OLD_EMAIL### The old network admin email address.
+     *         - ###NEW_EMAIL### The new network admin email address.
+     *         - ###SITENAME###  The name of the network.
+     *         - ###SITEURL###   The URL to the site.
+     *     @type string $headers Headers.
+     * }
      * @param string $old_email  The old network admin email address.
      * @param string $new_email  The new network admin email address.

trunk/src/wp-includes/user.php

@@ -2050 +2050 @@
              *
              * @param array $pass_change_email {
-             *            Used to build wp_mail().
+             *     Used to build wp_mail().
              *
-             *            @type string $to      The intended recipients. Add emails in a comma separated string.
-             *            @type string $subject The subject of the email.
-             *            @type string $message The content of the email.
-             *                The following strings have a special meaning and will get replaced dynamically:
-             *                - ###USERNAME###    The current user's username.
-             *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
-             *                - ###EMAIL###       The user's email address.
-             *                - ###SITENAME###    The name of the site.
-             *                - ###SITEURL###     The URL to the site.
-             *            @type string $headers Headers. Add headers in a newline (\r\n) separated string.
-             *        }
+             *     @type string $to      The intended recipients. Add emails in a comma separated string.
+             *     @type string $subject The subject of the email.
+             *     @type string $message The content of the email.
+             *         The following strings have a special meaning and will get replaced dynamically:
+             *         - ###USERNAME###    The current user's username.
+             *         - ###ADMIN_EMAIL### The admin email in case this was unexpected.
+             *         - ###EMAIL###       The user's email address.
+             *         - ###SITENAME###    The name of the site.
+             *         - ###SITEURL###     The URL to the site.
+             *     @type string $headers Headers. Add headers in a newline (\r\n) separated string.
+             * }
              * @param array $user     The original user array.
              * @param array $userdata The updated user array.
@@ -2108 +2108 @@
              *
              * @param array $email_change_email {
-             *            Used to build wp_mail().
+             *     Used to build wp_mail().
              *
-             *            @type string $to      The intended recipients.
-             *            @type string $subject The subject of the email.
-             *            @type string $message The content of the email.
-             *                The following strings have a special meaning and will get replaced dynamically:
-             *                - ###USERNAME###    The current user's username.
-             *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
-             *                - ###NEW_EMAIL###   The new email address.
-             *                - ###EMAIL###       The old email address.
-             *                - ###SITENAME###    The name of the site.
-             *                - ###SITEURL###     The URL to the site.
-             *            @type string $headers Headers.
-             *        }
+             *     @type string $to      The intended recipients.
+             *     @type string $subject The subject of the email.
+             *     @type string $message The content of the email.
+             *         The following strings have a special meaning and will get replaced dynamically:
+             *         - ###USERNAME###    The current user's username.
+             *         - ###ADMIN_EMAIL### The admin email in case this was unexpected.
+             *         - ###NEW_EMAIL###   The new email address.
+             *         - ###EMAIL###       The old email address.
+             *         - ###SITENAME###    The name of the site.
+             *         - ###SITEURL###     The URL to the site.
+             *     @type string $headers Headers.
+             * }
              * @param array $user     The original user array.
              * @param array $userdata The updated user array.