W3cubDocs

/WordPress

wpmu_signup_blog_notification( string $domain, string $path, string $title, string $user_login, string $user_email, string $key, array $meta = array() )

Send a confirmation request email to a user when they sign up for a new site. The new site will not become active until the confirmation link is clicked.

Description

This is the notification function used when site registration is enabled.

Filter ‘wpmu_signup_blog_notification’ to bypass this function or replace it with your own notification behavior.

Filter ‘wpmu_signup_blog_notification_email’ and ‘wpmu_signup_blog_notification_subject’ to change the content and subject line of the email sent to newly registered users.

Parameters

$domain

(string) (Required) The new blog domain.

$path

(string) (Required) The new blog path.

$title

(string) (Required) The site title.

$user_login

(string) (Required) The user's login name.

$user_email

(string) (Required) The user's email address.

$key

(string) (Required) The activation key created in wpmu_signup_blog()

$meta

(array) (Optional) Signup meta data. By default, contains the requested privacy setting and lang_id.

Default value: array()

Return

(bool)

Source

File: wp-includes/ms-functions.php 

function wpmu_signup_blog_notification( $domain, $path, $title, $user_login, $user_email, $key, $meta = array() ) {
	/**
	 * Filters whether to bypass the new site email notification.
	 *
	 * @since MU (3.0.0)
	 *
	 * @param string|bool $domain     Site domain.
	 * @param string      $path       Site path.
	 * @param string      $title      Site title.
	 * @param string      $user_login User login name.
	 * @param string      $user_email User email address.
	 * @param string      $key        Activation key created in wpmu_signup_blog().
	 * @param array       $meta       Signup meta data. By default, contains the requested privacy setting and lang_id.
	 */
	if ( ! apply_filters( 'wpmu_signup_blog_notification', $domain, $path, $title, $user_login, $user_email, $key, $meta ) ) {
		return false;
	}

	// Send email with activation link.
	if ( ! is_subdomain_install() || get_current_network_id() != 1 ) {
		$activate_url = network_site_url( "wp-activate.php?key=$key" );
	} else {
		$activate_url = "http://{$domain}{$path}wp-activate.php?key=$key"; // @todo Use *_url() API.
	}

	$activate_url = esc_url( $activate_url );

	$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";

	$user            = get_user_by( 'login', $user_login );
	$switched_locale = switch_to_locale( get_user_locale( $user ) );

	$message = sprintf(
		/**
		 * Filters the message content of the new blog notification email.
		 *
		 * Content should be formatted for transmission via wp_mail().
		 *
		 * @since MU (3.0.0)
		 *
		 * @param string $content    Content of the notification email.
		 * @param string $domain     Site domain.
		 * @param string $path       Site path.
		 * @param string $title      Site title.
		 * @param string $user_login User login name.
		 * @param string $user_email User email address.
		 * @param string $key        Activation key created in wpmu_signup_blog().
		 * @param array  $meta       Signup meta data. By default, contains the requested privacy setting and lang_id.
		 */
		apply_filters(
			'wpmu_signup_blog_notification_email',
			/* translators: New site notification email. 1: Activation URL, 2: New site URL. */
			__( "To activate your blog, please click the following link:\n\n%1\$s\n\nAfter you activate, you will receive *another email* with your login.\n\nAfter you activate, you can visit your site here:\n\n%2\$s" ),
			$domain,
			$path,
			$title,
			$user_login,
			$user_email,
			$key,
			$meta
		),
		$activate_url,
		esc_url( "http://{$domain}{$path}" ),
		$key
	);

	$subject = sprintf(
		/**
		 * Filters the subject of the new blog notification email.
		 *
		 * @since MU (3.0.0)
		 *
		 * @param string $subject    Subject of the notification email.
		 * @param string $domain     Site domain.
		 * @param string $path       Site path.
		 * @param string $title      Site title.
		 * @param string $user_login User login name.
		 * @param string $user_email User email address.
		 * @param string $key        Activation key created in wpmu_signup_blog().
		 * @param array  $meta       Signup meta data. By default, contains the requested privacy setting and lang_id.
		 */
		apply_filters(
			'wpmu_signup_blog_notification_subject',
			/* translators: New site notification email subject. 1: Network title, 2: New site URL. */
			_x( '[%1$s] Activate %2$s', 'New site notification email subject' ),
			$domain,
			$path,
			$title,
			$user_login,
			$user_email,
			$key,
			$meta
		),
		$from_name,
		esc_url( 'http://' . $domain . $path )
	);

	wp_mail( $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/load.php: get_current_network_id()

Retrieves the current network ID.
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/l10n.php: _x()

Retrieve translated string with gettext context.
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
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_user_by()

Retrieve user info by a given field
wp-includes/pluggable.php: wp_mail()

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

Retrieves the site URL for the current network.
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_signup_blog_notification

Filters whether to bypass the new site email notification.
wp-includes/ms-functions.php: wpmu_signup_blog_notification_email

Filters the message content of the new blog notification email.
wp-includes/ms-functions.php: wpmu_signup_blog_notification_subject

Filters the subject of the new blog notification email.
wp-includes/ms-load.php: is_subdomain_install()

Whether a subdomain configuration is enabled.

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_signup_blog_notification