update_welcome_user_email │ filter-hook │ WP 3.0.0

Filters the content of the welcome email after user activation.

Content should be formatted for transmission via wp_mail().

Usage

add_filter( 'update_welcome_user_email', 'wp_kama_update_welcome_user_email_filter', 10, 4 );

/**
 * Function for `update_welcome_user_email` filter-hook.
 * 
 * @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.
 *
 * @return string
 */
function wp_kama_update_welcome_user_email_filter( $welcome_email, $user_id, $password, $meta ){

	// filter...
	return $welcome_email;
}

$welcome_email(string)

The message body of the account activation success email.

$user_id(int)

User ID.

$password(string)

User password.

$meta(array)

Signup meta data.
Default: empty array

Changelog

Where the hook is called

$welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );

Where the hook is used in WordPress