apply_filters( 'email_change_email', array $email_change_email, array $user, array $userdata )
- Since
- 4.3.0
Filters the contents of the email sent when the user's email is changed.
Compatibility
- WordPress
- since 4.3.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$email_change_emailarray- { 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.
}$tostringThe intended recipients.$subjectstringThe subject of the email.$messagestringThe 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.$headersstringHeaders.
$userarray- The original user array.
$userdataarray- The updated user array.
Where this hook fires · 1
wp-includes/user.php:2923wp_update_user()
Source code
* - `###SITEURL###` The URL to the site. * @type string $headers Headers. * } * @param array $user The original user array. * @param array $userdata The updated user array. */ $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata ); $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] ); $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] ); $email_change_email['message'] = str_replace( '###NEW_EMAIL###', $userdata['user_email'], $email_change_email['message'] ); $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] ); $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] );Changelog
Introduced in 4.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.