Changeset 33245

Timestamp:

07/13/2015 10:14:45 PM (9 years ago)

Author:

DrewAPicture

Message:

Fix the inline documentation syntax in the hook docs for the email_change_email filter, introduced in 4.3.

Also update the filter summary to reflect that the file is for an "email" change, not a "password" change.

See [32820]. See #32891.

File:

• trunk/src/wp-includes/user.php (modified) (1 diff)

trunk/src/wp-includes/user.php

@@ -2276 +2276 @@
 
             /**
-             * Filter the email sent when the user's password is changed.
+             * Filter the contents of the email sent when the user's email is changed.
              *
              * @since 4.3.0
              *
              * @param array $email_change_email {
-             *            Used to build wp_mail(). https://developer.wordpress.org/reference/functions/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.
-             *                ###EMAIL###       The old email.
-             *                ###SITENAME###    The name of the site.
-             *                ###SITEURL###     The URL to the site.
+             *                - ###USERNAME###    The current user's username.
+             *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
+             *                - ###EMAIL###       The old email.
+             *                - ###SITENAME###    The name of the site.
+             *                - ###SITEURL###     The URL to the site.
              *            @type string $headers Headers.
              *        }