wpmu_welcome_notification

Notify a user that their blog activation has been successful.

Description

wpmu_welcome_notification( (int) $blog_id, (int) $user_id, (string) $password, (string) $title, (array) $meta = array() ); 

Filter to disable or bypass.

Filter and to modify the content and subject line of the notification email.

Parameters (5)

0. $blog_id (int)
The blog id.
1. $user_id (int)
The user id.
2. $password (string)
The password.
3. $title (string)
The new blog's title
4. $meta — Optional. (array) => array()
Not used in the default function, but is passed along to hooks for customization.

Usage

  1. if ( !function_exists( 'wpmu_welcome_notification' ) ) { 
  2.     require_once ABSPATH . WPINC . '/ms-functions.php'; 
  3. } 
  4.   
  5. // The blog id. 
  6. $blog_id = -1; 
  7.   
  8. // The user id. 
  9. $user_id = -1; 
  10.   
  11. // The password. 
  12. $password = ''; 
  13.   
  14. // The new blog's title 
  15. $title = ''; 
  16.   
  17. // Optional. Not used in the default function, but is passed along to hooks for customization. 
  18. $meta = array(); 
  19.   
  20. // NOTICE! Understand what this does before running. 
  21. $result = wpmu_welcome_notification($blog_id, $user_id, $password, $title, $meta); 
  22.     

Defined (1)

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

/wp-includes/ms-functions.php  
  1. function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) { 
  2.     $current_network = get_network(); 
  3.  
  4.     /** 
  5.      * Filters whether to bypass the welcome email after site activation. 
  6.      * 
  7.      * Returning false disables the welcome email. 
  8.      * 
  9.      * @since MU 
  10.      * 
  11.      * @param int|bool $blog_id  Blog ID. 
  12.      * @param int      $user_id  User ID. 
  13.      * @param string   $password User password. 
  14.      * @param string   $title    Site title. 
  15.      * @param array    $meta     Signup meta data. 
  16.      */ 
  17.     if ( ! apply_filters( 'wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta ) ) 
  18.         return false; 
  19.  
  20.     $user = get_userdata( $user_id ); 
  21.  
  22.     $switched_locale = switch_to_locale( get_user_locale( $user ) ); 
  23.  
  24.     $welcome_email = get_site_option( 'welcome_email' ); 
  25.     if ( $welcome_email == false ) { 
  26.         /** translators: Do not translate USERNAME, SITE_NAME, BLOG_URL, PASSWORD: those are placeholders. */ 
  27.         $welcome_email = __( 'Howdy USERNAME,  
  28.  
  29. Your new SITE_NAME site has been successfully set up at: 
  30. BLOG_URL 
  31.  
  32. You can log in to the administrator account with the following information: 
  33.  
  34. Username: USERNAME 
  35. Password: PASSWORD 
  36. Log in here: BLOG_URLwp-login.php 
  37.  
  38. We hope you enjoy your new site. Thanks! 
  39.  
  40. --The Team @ SITE_NAME' ); 
  41.     } 
  42.  
  43.     $url = get_blogaddress_by_id($blog_id); 
  44.  
  45.     $welcome_email = str_replace( 'SITE_NAME', $current_network->site_name, $welcome_email ); 
  46.     $welcome_email = str_replace( 'BLOG_TITLE', $title, $welcome_email ); 
  47.     $welcome_email = str_replace( 'BLOG_URL', $url, $welcome_email ); 
  48.     $welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email ); 
  49.     $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email ); 
  50.  
  51.     /** 
  52.      * Filters the content of the welcome email after site activation. 
  53.      * 
  54.      * Content should be formatted for transmission via wp_mail(). 
  55.      * 
  56.      * @since MU 
  57.      * 
  58.      * @param string $welcome_email Message body of the email. 
  59.      * @param int    $blog_id       Blog ID. 
  60.      * @param int    $user_id       User ID. 
  61.      * @param string $password      User password. 
  62.      * @param string $title         Site title. 
  63.      * @param array  $meta          Signup meta data. 
  64.      */ 
  65.     $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta ); 
  66.     $admin_email = get_site_option( 'admin_email' ); 
  67.  
  68.     if ( $admin_email == '' ) 
  69.         $admin_email = 'support@' . $_SERVER['SERVER_NAME']; 
  70.  
  71.     $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) ); 
  72.     $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n"; 
  73.     $message = $welcome_email; 
  74.  
  75.     if ( empty( $current_network->site_name ) ) 
  76.         $current_network->site_name = 'WordPress'; 
  77.  
  78.     /** translators: New site notification email subject. 1: Network name, 2: New site name */ 
  79.     $subject = __( 'New %1$s Site: %2$s' ); 
  80.  
  81.     /** 
  82.      * Filters the subject of the welcome email after site activation. 
  83.      * 
  84.      * @since MU 
  85.      * 
  86.      * @param string $subject Subject of the email. 
  87.      */ 
  88.     $subject = apply_filters( 'update_welcome_subject', sprintf( $subject, $current_network->site_name, wp_unslash( $title ) ) ); 
  89.     wp_mail( $user->user_email, wp_specialchars_decode( $subject ), $message, $message_headers ); 
  90.  
  91.     if ( $switched_locale ) { 
  93.     } 
  94.  
  95.     return true; 
  96. }