wppaste
WordPress

newuser_notify_siteadmin( int $user_id ): bool

Since
MU (3.0.0)
Source
wp-includes/ms-functions.php:1529
Notifies the network admin that a new user has been activated.

Description

Filter 'newuser_notify_siteadmin' to change the content of the notification email.

Compatibility

WordPress
since MU (3.0.0)
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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
The new user's ID.

Return value

bool

Performance profile

How much work a call to newuser_notify_siteadmin() 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
7–62

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

Plugin surface
1 hook

Third-party callbacks on 'newuser_notify_siteadmin' 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

  • optionnetwork optionget_site_option()called directly
  • hookthird-party callbacksapply_filters()called directly
  • mailsends mailwp_mail()called directly
  • querycontent queryget_user_by()one call below newuser_notify_siteadmin()

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

What one call costs · 3 distinct outcomes

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

WhenInstructionsCalls it makes
always7get_site_option()
!is_email()15get_site_option(), get_site_option(), is_email()
is_email()62get_site_option(), get_site_option(), is_email(), get_userdata(), network_admin_url(), esc_url(), __(), wp_unslash(), sprintf(), apply_filters(), __(), sprintf(), wp_mail()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 64 instructions, 7–62 executed per call, 2 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

One hook fires while newuser_notify_siteadmin() runs, in this order:

  1. apply_filters( newuser_notify_siteadmin )filterline 1566 (+37 into the body)

    Filters the message body of the new user activation email sent to the network administrator.

Uses · 9

  • get_site_option()Retrieve an option value for the current network based on name of option.
  • is_email()Verifies that an email is valid.
  • get_userdata()Retrieves user info by user ID.
  • esc_url()Checks and cleans a URL.
  • network_admin_url()Retrieves the URL to the admin area for the network.
  • __()Retrieves the translation of $text.
  • wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
  • apply_filters()Calls the callback functions that have been added to a filter hook.
  • wp_mail()Sends an email, similar to PHP's mail function.

Source code

View on Trac View on GitHub 

function newuser_notify_siteadmin( $user_id ) {	if ( 'yes' !== get_site_option( 'registrationnotification' ) ) {		return false;	} 	$email = get_site_option( 'admin_email' ); 	if ( ! is_email( $email ) ) {		return false;	} 	$user = get_userdata( $user_id ); 	$options_site_url = esc_url( network_admin_url( 'settings.php' ) ); 	$msg = sprintf(		/* translators: New user notification email. 1: User login, 2: User IP address, 3: URL to Network Settings screen. */		__(			'New User: %1$sRemote IP address: %2$s Disable these notifications: %3$s'		),		$user->user_login,		wp_unslash( $_SERVER['REMOTE_ADDR'] ),		$options_site_url	); 	/**	 * Filters the message body of the new user activation email sent	 * to the network administrator.	 *	 * @since MU (3.0.0)	 *	 * @param string  $msg  Email body.	 * @param WP_User $user WP_User instance of the new user.	 */	$msg = apply_filters( 'newuser_notify_siteadmin', $msg, $user ); 	/* translators: New user notification email subject. %s: User login. */	wp_mail( $email, sprintf( __( 'New User Registration: %s' ), $user->user_login ), $msg ); 	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 6.9.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.