wpmu_welcome_user_notification( int $user_id, string $password, 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_idint

User ID.

$passwordstring

User password.

$metaarrayoptional

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

Return value

bool

Performance profile

How much work a call to wpmu_welcome_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

14–124

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

Plugin surface

3 hooks

Third-party callbacks on 'wpmu_welcome_user_notification', 'update_welcome_user_email', 'update_welcome_user_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
• optionnetwork optionget_site_option()called directly
• mailsends mailwp_mail()called directly
• querycontent queryget_user_by()one call below wpmu_welcome_user_notification()
• cacheobject cachewp_cache_get()one call below wpmu_welcome_user_notification()
• serializeserialisationmaybe_unserialize()one call below wpmu_welcome_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 · 9 distinct outcomes

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

Hooks and filters fired · 3

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

1. 1
   apply_filters( wpmu_welcome_user_notification )filterline 1897 (+19 into the body)

   Filters whether to bypass the welcome email after user activation.

2. 2
   apply_filters( update_welcome_user_email )filterline 1919 (+41 into the body)

   Filters the content of the welcome email after user activation.

3. 3
   apply_filters( update_welcome_user_subject )filterline 1949 (+71 into the body)

   Filters the subject of the welcome email after user activation.

Uses · 14

• get_network()Retrieves network data given a network ID or network object.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_site_option()Retrieve an option value for the current network based on name of option.
• get_userdata()Retrieves user info by user ID.
• switch_to_user_locale()Switches the translations according to the given user's locale.
• wp_login_url()Retrieves the login URL.
• 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.
• wp_mail()Sends an email, similar to PHP's mail function.

Source code

View on Trac ↗View on GitHub ↗

1878function wpmu_welcome_user_notification(1879	$user_id,1880	#[\SensitiveParameter]1881	$password,1882	$meta = array()1883) {1884	$current_network = get_network();1885 1886	/**1887	 * Filters whether to bypass the welcome email after user activation.1888	 *1889	 * Returning false disables the welcome email.1890	 *1891	 * @since MU (3.0.0)1892	 *1893	 * @param int    $user_id  User ID.1894	 * @param string $password User password.1895	 * @param array  $meta     Signup meta data. Default empty array.1896	 */1897	if ( ! apply_filters( 'wpmu_welcome_user_notification', $user_id, $password, $meta ) ) {1898		return false;1899	}1900 1901	$welcome_email = get_site_option( 'welcome_user_email' );1902 1903	$user = get_userdata( $user_id );1904 1905	$switched_locale = switch_to_user_locale( $user_id );1906 1907	/**1908	 * Filters the content of the welcome email after user activation.1909	 *1910	 * Content should be formatted for transmission via wp_mail().1911	 *1912	 * @since MU (3.0.0)1913	 *1914	 * @param string $welcome_email The message body of the account activation success email.1915	 * @param int    $user_id       User ID.1916	 * @param string $password      User password.1917	 * @param array  $meta          Signup meta data. Default empty array.1918	 */1919	$welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );1920	$welcome_email = str_replace( 'SITE_NAME', $current_network->site_name, $welcome_email );1921	$welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );1922	$welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );1923	$welcome_email = str_replace( 'LOGINLINK', wp_login_url(), $welcome_email );1924 1925	$admin_email = get_site_option( 'admin_email' );1926 1927	if ( '' === $admin_email ) {1928		$admin_email = 'support@' . wp_parse_url( network_home_url(), PHP_URL_HOST );1929	}1930 1931	$from_name       = ( '' !== get_site_option( 'site_name' ) ) ? esc_html( get_site_option( 'site_name' ) ) : 'WordPress';1932	$message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . 'Content-Type: text/plain; charset="' . get_option( 'blog_charset' ) . "\"\n";1933	$message         = $welcome_email;1934 1935	if ( empty( $current_network->site_name ) ) {1936		$current_network->site_name = 'WordPress';1937	}1938 1939	/* translators: New user notification email subject. 1: Network title, 2: New user login. */1940	$subject = __( 'New %1$s User: %2$s' );1941 1942	/**1943	 * Filters the subject of the welcome email after user activation.1944	 *1945	 * @since MU (3.0.0)1946	 *1947	 * @param string $subject Subject of the email.1948	 */1949	$subject = apply_filters( 'update_welcome_user_subject', sprintf( $subject, $current_network->site_name, $user->user_login ) );1950 1951	wp_mail( $user->user_email, wp_specialchars_decode( $subject ), $message, $message_headers );1952 1953	if ( $switched_locale ) {1954		restore_previous_locale();1955	}1956 1957	return true;

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 7.0.4 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.