W3cubDocs

/WordPress

wpmu_welcome_user_notification( int $user_id, string $password, array $meta = array() )

Notify a user that their account activation has been successful.

Description

Filter ‘wpmu_welcome_user_notification’ to disable or bypass.

Filter ‘update_welcome_user_email’ and ‘update_welcome_user_subject’ to modify the content and subject line of the notification email.

Parameters

$user_id

(int) (Required) User ID.

$password

(string) (Required) User password.

$meta

(array) (Optional) Signup meta data.

Default value: array()

Return

(bool)

Source

File: wp-includes/ms-functions.php 

function wpmu_welcome_user_notification( $user_id, $password, $meta = array() ) {
	$current_network = get_network();

	/**
	 * Filters whether to bypass the welcome email after user activation.
	 *
	 * Returning false disables the welcome email.
	 *
	 * @since MU (3.0.0)
	 *
	 * @param int    $user_id  User ID.
	 * @param string $password User password.
	 * @param array  $meta     Signup meta data. Default empty array.
	 */
	if ( ! apply_filters( 'wpmu_welcome_user_notification', $user_id, $password, $meta ) ) {
		return false;
	}

	$welcome_email = get_site_option( 'welcome_user_email' );

	$user = get_userdata( $user_id );

	$switched_locale = switch_to_locale( get_user_locale( $user ) );

	/**
	 * Filters the content of the welcome email after user activation.
	 *
	 * Content should be formatted for transmission via wp_mail().
	 *
	 * @since MU (3.0.0)
	 *
	 * @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. Default empty array.
	 */
	$welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );
	$welcome_email = str_replace( 'SITE_NAME', $current_network->site_name, $welcome_email );
	$welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );
	$welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
	$welcome_email = str_replace( 'LOGINLINK', wp_login_url(), $welcome_email );

	$admin_email = get_site_option( 'admin_email' );

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

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

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

	/* translators: New user notification email subject. 1: Network title, 2: New user login. */
	$subject = __( 'New %1$s User: %2$s' );

	/**
	 * Filters the subject of the welcome email after user activation.
	 *
	 * @since MU (3.0.0)
	 *
	 * @param string $subject Subject of the email.
	 */
	$subject = apply_filters( 'update_welcome_user_subject', sprintf( $subject, $current_network->site_name, $user->user_login ) );

	wp_mail( $user->user_email, wp_specialchars_decode( $subject ), $message, $message_headers );

	if ( $switched_locale ) {
		restore_previous_locale();
	}

	return true;
}

Uses

Uses Description
wp-includes/l10n.php: restore_previous_locale()

Restores the translations according to the previous locale.
wp-includes/l10n.php: switch_to_locale()

Switches the translations according to the given locale.
wp-includes/l10n.php: get_user_locale()

Retrieves the locale of a user.
wp-includes/ms-network.php: get_network()

Retrieves network data given a network ID or network object.
wp-includes/http.php: wp_parse_url()

A wrapper for PHP’s parse_url() function that handles consistency in the return values across PHP versions.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: esc_html()

Escaping for HTML blocks.
wp-includes/formatting.php: wp_specialchars_decode()

Converts a number of HTML entities into their special characters.
wp-includes/pluggable.php: get_userdata()

Retrieve user info by user ID.
wp-includes/pluggable.php: wp_mail()

Sends an email, similar to PHP’s mail function.
wp-includes/general-template.php: wp_login_url()

Retrieves the login URL.
wp-includes/link-template.php: network_home_url()

Retrieves the home URL for the current network.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/option.php: get_site_option()

Retrieve an option value for the current network based on name of option.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/ms-functions.php: wpmu_welcome_user_notification

Filters whether to bypass the welcome email after user activation.
wp-includes/ms-functions.php: update_welcome_user_email

Filters the content of the welcome email after user activation.
wp-includes/ms-functions.php: update_welcome_user_subject

Filters the subject of the welcome email after user activation.

Changelog

Version Description
MU (3.0.0) Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wpmu_welcome_user_notification