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.


git-svn-id: https://develop.svn.wordpress.org/trunk@33245 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-07-13 22:14:45 +00:00
parent a15b51fc6f
commit ce8944600a
1 changed files with 7 additions and 7 deletions

View File

@ -2275,21 +2275,21 @@ All at ###SITENAME###
); );
/** /**
* 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 * @since 4.3.0
* *
* @param array $email_change_email { * @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 $to The intended recipients.
* @type string $subject The subject of the email. * @type string $subject The subject of the email.
* @type string $message The content of the email. * @type string $message The content of the email.
* The following strings have a special meaning and will get replaced dynamically: * The following strings have a special meaning and will get replaced dynamically:
* ###USERNAME### The current user's username. * - ###USERNAME### The current user's username.
* ###ADMIN_EMAIL### The admin email in case this was unexpected. * - ###ADMIN_EMAIL### The admin email in case this was unexpected.
* ###EMAIL### The old email. * - ###EMAIL### The old email.
* ###SITENAME### The name of the site. * - ###SITENAME### The name of the site.
* ###SITEURL### The URL to the site. * - ###SITEURL### The URL to the site.
* @type string $headers Headers. * @type string $headers Headers.
* } * }
* @param array $user The original user array. * @param array $user The original user array.