wpmu_welcome_notification( int $blog_id, int $user_id, string $password, string $title, 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

$blog_idint

Site ID.

$user_idint

User ID.

$passwordstring

User password, or "N/A" if the user account is not new.

$titlestring

Site title.

$metaarrayoptional

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

Return value

bool

Whether the email notification was sent.

Performance profile

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

18–142

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

Plugin surface

3 hooks

Third-party callbacks on 'wpmu_welcome_notification', 'update_welcome_email', 'update_welcome_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_notification()
• cacheobject cachewp_cache_get()one call below wpmu_welcome_notification()
• serializeserialisationmaybe_unserialize()one call below wpmu_welcome_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_welcome_notification() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

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

1. 1
   apply_filters( wpmu_welcome_notification )filterline 1678 (+23 into the body)

   Filters whether to bypass the welcome email sent to the site administrator after site activation.

2. 2
   apply_filters( update_welcome_email )filterline 1730 (+75 into the body)

   Filters the content of the welcome email sent to the site administrator after site activation.

3. 3
   apply_filters( update_welcome_subject )filterline 1756 (+101 into the body)

   Filters the subject of the welcome email sent to the site administrator after site activation.

Uses · 15

• 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_userdata()Retrieves user info by user ID.
• 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.
• __()Retrieves the translation of $text.
• get_blogaddress_by_id()Gets a full site URL, given a site ID.
• 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.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.

Source code

View on Trac ↗View on GitHub ↗

1655function wpmu_welcome_notification(1656	$blog_id,1657	$user_id,1658	#[\SensitiveParameter]1659	$password,1660	$title,1661	$meta = array()1662) {1663	$current_network = get_network();1664 1665	/**1666	 * Filters whether to bypass the welcome email sent to the site administrator after site activation.1667	 *1668	 * Returning false disables the welcome email.1669	 *1670	 * @since MU (3.0.0)1671	 *1672	 * @param int|false $blog_id  Site ID, or false to prevent the email from sending.1673	 * @param int       $user_id  User ID of the site administrator.1674	 * @param string    $password User password, or "N/A" if the user account is not new.1675	 * @param string    $title    Site title.1676	 * @param array     $meta     Signup meta data. By default, contains the requested privacy setting and lang_id.1677	 */1678	if ( ! apply_filters( 'wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta ) ) {1679		return false;1680	}1681 1682	$user = get_userdata( $user_id );1683 1684	$switched_locale = switch_to_user_locale( $user_id );1685 1686	$welcome_email = get_site_option( 'welcome_email' );1687 1688	if ( ! $welcome_email ) {1689		/* translators: Do not translate USERNAME, SITE_NAME, BLOG_URL, PASSWORD: those are placeholders. */1690		$welcome_email = __(1691			'Howdy USERNAME,1692 1693Your new SITE_NAME site has been successfully set up at:1694BLOG_URL1695 1696You can log in to the administrator account with the following information:1697 1698Username: USERNAME1699Password: PASSWORD1700Log in here: BLOG_URLwp-login.php1701 1702We hope you enjoy your new site. Thanks!1703 1704--The Team @ SITE_NAME'1705		);1706	}1707 1708	$url = get_blogaddress_by_id( $blog_id );1709 1710	$welcome_email = str_replace( 'SITE_NAME', $current_network->site_name, $welcome_email );1711	$welcome_email = str_replace( 'BLOG_TITLE', $title, $welcome_email );1712	$welcome_email = str_replace( 'BLOG_URL', $url, $welcome_email );1713	$welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );1714	$welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );1715 1716	/**1717	 * Filters the content of the welcome email sent to the site administrator after site activation.1718	 *1719	 * Content should be formatted for transmission via wp_mail().1720	 *1721	 * @since MU (3.0.0)1722	 *1723	 * @param string $welcome_email Message body of the email.1724	 * @param int    $blog_id       Site ID.1725	 * @param int    $user_id       User ID of the site administrator.1726	 * @param string $password      User password, or "N/A" if the user account is not new.1727	 * @param string $title         Site title.1728	 * @param array  $meta          Signup meta data. By default, contains the requested privacy setting and lang_id.1729	 */1730	$welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta );1731 1732	$admin_email = get_site_option( 'admin_email' );1733 1734	if ( '' === $admin_email ) {

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