update_welcome_email │ filter-hook │ WP 3.0.0

Filters the content of the welcome email sent to the site administrator after site activation.

Content should be formatted for transmission via wp_mail().

Usage

add_filter( 'update_welcome_email', 'wp_kama_update_welcome_email_filter', 10, 6 );

/**
 * Function for `update_welcome_email` filter-hook.
 * 
 * @param string $welcome_email Message body of the email.
 * @param int    $blog_id       Site ID.
 * @param int    $user_id       User ID of the site administrator.
 * @param string $password      User password, or "N/A" if the user account is not new.
 * @param string $title         Site title.
 * @param array  $meta          Signup meta data. By default, contains the requested privacy setting and lang_id.
 *
 * @return string
 */
function wp_kama_update_welcome_email_filter( $welcome_email, $blog_id, $user_id, $password, $title, $meta ){

	// filter...
	return $welcome_email;
}

$welcome_email(string)

Message body of the email.

$blog_id(int)

Site ID.

$user_id(int)

User ID of the site administrator.

$password(string)

User password, or "N/A" if the user account is not new.

$title(string)

Site title.

$meta(array)

Signup meta data. By default, contains the requested privacy setting and lang_id.

Changelog

Where the hook is called

$welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta );

Where the hook is used in WordPress