update_welcome_email

Filters the content of the welcome email after site activation.

Description

apply_filters( 'update_welcome_email', (string) $welcome_email, (int) $blog_id, (int) $user_id, (string) $password, (string) $title, (array) $meta ); 

Content should be formatted for transmission via wp_mail().

Parameters (6)

0. $welcome_email (string)
Message body of the email.
1. $blog_id (int)
The blog id.
2. $user_id (int)
The user id.
3. $password (string)
User password.
4. $title (string)
Site title.
5. $meta (array)
Signup meta data.

Usage

To run the hook, copy the example below.
  1. $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta ); 
  2.  
  3. if ( !empty( $welcome_email ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the update_welcome_email callback 
  2. function filter_update_welcome_email( $welcome_email, $blog_id, $user_id, $password, $title, $meta ) { 
  3. // make filter magic happen here... 
  4. return $welcome_email
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'update_welcome_email', 'filter_update_welcome_email', 10, 6 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'update_welcome_email', 'filter_update_welcome_email', 10, 6 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/ms-functions.php  
  1. $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta );