Changeset 48107

Timestamp:

06/20/2020 12:20:24 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Miscellaneous DocBlock corrections for email filters in wp-includes/user.php.

See #49572.

File:

• trunk/src/wp-includes/user.php (modified) (5 diffs)

trunk/src/wp-includes/user.php

@@ -2048 +2048 @@
              * @param array $pass_change_email {
              *            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.
@@ -2105 +2106 @@
              * @param array $email_change_email {
              *            Used to build wp_mail().
+             *
              *            @type string $to      The intended recipients.
              *            @type string $subject The subject of the email.
@@ -2117 +2119 @@
              *            @type string $headers Headers.
              *        }
-             * @param array $user The original user array.
+             * @param array $user     The original user array.
              * @param array $userdata The updated user array.
              */
@@ -2276 +2278 @@
  *
  * @param WP_User $user User to retrieve password reset key for.
- *
  * @return string|WP_Error Password reset key on success. WP_Error on error.
  */
@@ -2869 +2870 @@
          *
          * The following strings have a special meaning and will get replaced dynamically:
-         * ###USERNAME###  The current user's username.
-         * ###ADMIN_URL### The link to click on to confirm the email change.
-         * ###EMAIL###     The new email.
-         * ###SITENAME###  The name of the site.
-         * ###SITEURL###   The URL to the site.
+         * - ###USERNAME###  The current user's username.
+         * - ###ADMIN_URL### The link to click on to confirm the email change.
+         * - ###EMAIL###     The new email.
+         * - ###SITENAME###  The name of the site.
+         * - ###SITEURL###   The URL to the site.
          *
          * @since MU (3.0.0)