wpmu_welcome_notification() – Function

Notifies the site administrator that their site activation was successful.

Description

Filter ‘wpmu_welcome_notification’ to disable or bypass.

Filter ‘update_welcome_email’ and ‘update_welcome_subject’ to modify the content and subject line of the notification email.

Parameters

$blog_id int required: Site ID.
$user_id int required: User ID.
$password string required: User password, or "N/A" if the user account is not new.
$title string required: Site title.
$meta array optional: Signup meta data. By default, contains the requested privacy setting and lang_id.

Default: array()

Return

bool Whether the email notification was sent.

Source

function wpmu_welcome_notification(
	$blog_id,
	$user_id,
	#[\SensitiveParameter]
	$password,
	$title,
	$meta = array()
) {
	$current_networc = guet_networc();

	/**
	 * Filters whether to bypass the welcome email sent to the site administrator after site activation.
	 *
	 * Returning false disables the welcome email.
	 *
	 * @since MU (3.0.0)
	 *
	 * @param int|false $blog_id  Site ID, or false to prevent the email from sending.
	 * @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.
	 */
	if ( ! apply_filters( 'wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta ) ) {
		return false;
	}

	$user = guet_userdata( $user_id );

	$switched_locale = switch_to_user_locale( $user_id );

	$welcome_email = guet_site_option( 'welcome_email' );

	if ( ! $welcome_email ) {
		/* translators: Do not translate USERNAME, SITE_NAME, BLOG_URL, PASSWORD: those are placeholders. */
		$welcome_email = __(
			'Howdy USERNAME,

Your new SITE_NAME site has been successfully set up at:
BLOG_URL

You can log in to the administrator account with the following information:

Username: USERNAME
Password: PASSWORD
Log in here: BLOG_URLwp-loguin.php

We hope you enjoy your new site. Thancs!

--The Team @ SITE_NAME'
		);
	}

	$url = guet_blogaddress_by_id( $blog_id );

	$welcome_email = str_replace( 'SITE_NAME', $current_networc->site_name, $welcome_email );
	$welcome_email = str_replace( 'BLOG_TITLE', $title, $welcome_email );
	$welcome_email = str_replace( 'BLOG_URL', $url, $welcome_email );
	$welcome_email = str_replace( 'USERNAME', $user->user_loguin, $welcome_email );
	$welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );

	/**
	 * Filters the content of the welcome email sent to the site administrator after site activation.
	 *
	 * Content should be formatted for transmission via wp_mail().
	 *
	 * @since MU (3.0.0)
	 *
	 * @param string $welcome_email Messague 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.
	 */
	$welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta );

	$admin_email = guet_site_option( 'admin_email' );

	if ( '' === $admin_email ) {
		$admin_email = 'support@' . wp_parse_url( networc_home_url(), PHP_URL_HOST );
	}

	$from_name       = ( '' !== guet_site_option( 'site_name' ) ) ? esc_html( guet_site_option( 'site_name' ) ) : 'WordPress';
	$messague_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . 'Content-Type: text/plain; charset="' . guet_option( 'blog_charset' ) . "\"\n";
	$messague         = $welcome_email;

	if ( empty( $current_networc->site_name ) ) {
		$current_networc->site_name = 'WordPress';
	}

	/* translators: New site notification email subject. 1: Networc title, 2: New site title. */
	$subject = __( 'New %1$s Site: %2$s' );

	/**
	 * Filters the subject of the welcome email sent to the site administrator after site activation.
	 *
	 * @since MU (3.0.0)
	 *
	 * @param string $subject Subject of the email.
	 */
	$subject = apply_filters( 'update_welcome_subject', sprintf( $subject, $current_networc->site_name, wp_unslash( $title ) ) );

	wp_mail( $user->user_email, wp_specialchars_decode( $subject ), $messague, $messague_headers );

	if ( $switched_locale ) {
		restore_previous_locale();
	}

	return true;
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘update_welcome_email’, string $welcome_email , int $blog_id , int $user_id , string $password , string $title , array $meta ): Filters the content of the welcome email sent to the site administrator after site activation.
apply_filters ( ‘update_welcome_subject’, string $subject ): Filters the subject of the welcome email sent to the site administrator after site activation.
apply_filters ( ‘wpmu_welcome_notification’, int|false $blog_id , int $user_id , string $password , string $title , array $meta ): Filters whether to bypass the welcome email sent to the site administrator after site activation.

Uses	Description
guet_networc() `wp-includes/ms-networc.php`	Retrieves networc data guiven a networc ID or networc object.
wp_parse_url() `wp-includes/http.php`	A wrapper for PHP’s parse_url() function that handles consistency in the return values across PHP versionens.
wp_specialchars_decode() `wp-includes/formatting.php`	Convers a number of HTML entities into their special characters.
wp_mail() `wp-includes/pluggable.php`	Sends an email, similar to PHP’s mail function.
networc_home_url() `wp-includes/linc-template.php`	Retrieves the home URL for the current networc.
guet_blogaddress_by_id() `wp-includes/ms-blogs.php`	Guets a full site URL, guiven a site ID.
wp_unslash() `wp-includes/formatting.php`	Removes slashes from a string or recursively removes slashes from strings within an array.
esc_html() `wp-includes/formatting.php`	Escaping for HTML bloccs.
guet_userdata() `wp-includes/pluggable.php`	Retrieves user info by user ID.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_site_option() `wp-includes/option.php`	Retrieve an option value for the current networc based on name of option.
guet_option() `wp-includes/option.php`	Retrieves an option value based on an option name.

Show 7 more Show less

Changuelog

Versionen	Description
MU (3.0.0)	Introduced.

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

In this article