apply_filters( 'update_welcome_user_email', string $welcome_email, int $user_id, string $password, array $meta )
- Since
- MU (3.0.0)
Filters the content of the welcome email after user activation.
Description
Content should be formatted for transmission via wp_mail().
Compatibility
- WordPress
- since MU (3.0.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
$welcome_emailstring- The message body of the account activation success email.
$user_idint- User ID.
$passwordstring- User password.
$metaarray- Signup meta data. Default empty array.
Where this hook fires · 1
wp-includes/ms-functions.php:1937wpmu_welcome_user_notification()
Source code
* * @param string $welcome_email The message body of the account activation success email. * @param int $user_id User ID. * @param string $password User password. * @param array $meta Signup meta data. Default empty array. */ $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta ); $welcome_email = str_replace( 'SITE_NAME', $current_network->site_name, $welcome_email ); $welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email ); $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email ); $welcome_email = str_replace( 'LOGINLINK', wp_login_url(), $welcome_email ); $admin_email = get_site_option( 'admin_email' );Changelog
Introduced in MU (3.0.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.