wpmu_signup_user_notification( string $user_login, string $user_email, string $key, array $meta = array() ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$user_loginstring

The user's login name.

$user_emailstring

The user's email address.

$keystring

The activation key created in wpmu_signup_user()

$metaarrayoptional

Signup meta data. Default empty array.Default: array()

Return value

bool

Performance profile

How much work a call to wpmu_signup_user_notification() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Sends mail via wp_mail().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

13–115

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 117.

Plugin surface

3 hooks

Third-party callbacks on 'wpmu_signup_user_notification', 'wpmu_signup_user_notification_email', 'wpmu_signup_user_notification_subject' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_user_by()called directly
• optionnetwork optionget_site_option()called directly
• mailsends mailwp_mail()called directly
• cacheobject cachewp_cache_get()one call below wpmu_signup_user_notification()
• serializeserialisationmaybe_unserialize()one call below wpmu_signup_user_notification()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 17 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wpmu_signup_user_notification() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while wpmu_signup_user_notification() runs, in this order:

1. 1
   apply_filters( wpmu_signup_user_notification )filterline 1071 (+11 into the body)

   Filters whether to bypass the email notification for new user sign-up.

2. 2
   apply_filters( wpmu_signup_user_notification_email )filterline 1101 (+41 into the body)

   Filters the content of the notification email for new user sign-up.

3. 3
   apply_filters( wpmu_signup_user_notification_subject )filterline 1125 (+65 into the body)

   Filters the subject of the notification email of new user signup.

Uses · 14

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_user_by()Retrieves user info by a given field.
• switch_to_user_locale()Switches the translations according to the given user's locale.
• get_site_option()Retrieve an option value for the current network based on name of option.
• wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.
• network_home_url()Retrieves the home URL for the current network.
• esc_html()Escaping for HTML blocks.
• get_option()Retrieves an option value based on an option name.
• __()Retrieves the translation of $text.
• site_url()Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
• _x()Retrieves translated string with gettext context.
• wp_mail()Sends an email, similar to PHP's mail function.

Source code

View on Trac ↗View on GitHub ↗

1060function wpmu_signup_user_notification( $user_login, $user_email, $key, $meta = array() ) {1061	/**1062	 * Filters whether to bypass the email notification for new user sign-up.1063	 *1064	 * @since MU (3.0.0)1065	 *1066	 * @param string $user_login User login name.1067	 * @param string $user_email User email address.1068	 * @param string $key        Activation key created in wpmu_signup_user().1069	 * @param array  $meta       Signup meta data. Default empty array.1070	 */1071	if ( ! apply_filters( 'wpmu_signup_user_notification', $user_login, $user_email, $key, $meta ) ) {1072		return false;1073	}1074 1075	$user            = get_user_by( 'login', $user_login );1076	$switched_locale = $user && switch_to_user_locale( $user->ID );1077 1078	// Send email with activation link.1079	$admin_email = get_site_option( 'admin_email' );1080 1081	if ( '' === $admin_email ) {1082		$admin_email = 'support@' . wp_parse_url( network_home_url(), PHP_URL_HOST );1083	}1084 1085	$from_name       = ( '' !== get_site_option( 'site_name' ) ) ? esc_html( get_site_option( 'site_name' ) ) : 'WordPress';1086	$message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . 'Content-Type: text/plain; charset="' . get_option( 'blog_charset' ) . "\"\n";1087	$message         = sprintf(1088		/**1089		 * Filters the content of the notification email for new user sign-up.1090		 *1091		 * Content should be formatted for transmission via wp_mail().1092		 *1093		 * @since MU (3.0.0)1094		 *1095		 * @param string $content    Content of the notification email.1096		 * @param string $user_login User login name.1097		 * @param string $user_email User email address.1098		 * @param string $key        Activation key created in wpmu_signup_user().1099		 * @param array  $meta       Signup meta data. Default empty array.1100		 */1101		apply_filters(1102			'wpmu_signup_user_notification_email',1103			/* translators: New user notification email. %s: Activation URL. */1104			__( "To activate your user, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login." ),1105			$user_login,1106			$user_email,1107			$key,1108			$meta1109		),1110		site_url( "wp-activate.php?key=$key" )1111	);1112 1113	$subject = sprintf(1114		/**1115		 * Filters the subject of the notification email of new user signup.1116		 *1117		 * @since MU (3.0.0)1118		 *1119		 * @param string $subject    Subject of the notification email.1120		 * @param string $user_login User login name.1121		 * @param string $user_email User email address.1122		 * @param string $key        Activation key created in wpmu_signup_user().1123		 * @param array  $meta       Signup meta data. Default empty array.1124		 */1125		apply_filters(1126			'wpmu_signup_user_notification_subject',1127			/* translators: New user notification email subject. 1: Network title, 2: New user login. */1128			_x( '[%1$s] Activate %2$s', 'New user notification email subject' ),1129			$user_login,1130			$user_email,1131			$key,1132			$meta1133		),1134		$from_name,1135		$user_login1136	);1137 1138	wp_mail( $user_email, wp_specialchars_decode( $subject ), $message, $message_headers );1139

Changelog

Introduced in MU (3.0.0). Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/ms-functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.