update_welcome_user_email
Filters the content of the welcome email after user activation.
Description
apply_filters( 'update_welcome_user_email', (string) $welcome_email, (int) $user_id, (string) $password, (array) $meta );
Content should be formatted for transmission via wp_mail(…)
.
Parameters (4)
- 0. $welcome_email (string)
- The message body of the account activation success email.
- 1. $user_id (int)
- The user id.
- 2. $password (string)
- User password.
- 3. $meta (array)
- Signup meta data.
Usage
- To run the hook, copy the example below.
- $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );
- if ( !empty( $welcome_email ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the update_welcome_user_email callback
- function filter_update_welcome_user_email( $welcome_email, $user_id, $password, $meta ) {
- // make filter magic happen here...
- return $welcome_email;
- };
- // add the filter
- add_filter( 'update_welcome_user_email', 'filter_update_welcome_user_email', 10, 4 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'update_welcome_user_email', 'filter_update_welcome_user_email', 10, 4 );
Defined (1)
The filter is defined in the following location(s).
- /wp-includes/ms-functions.php
- $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );