wp_site_admin_email_change_notification( string $old_email, string $new_email, string $option_name )

Compatibility

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

Parameters

$old_emailstring

The old site admin email address.

$new_emailstring

The new site admin email address.

$option_namestring

The relevant database option name.

Performance profile

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

16–84

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

Plugin surface

2 hooks

Third-party callbacks on 'send_site_admin_email_change_email', 'site_admin_email_change_email' 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
• optionoption read or writeget_option()called directly
• mailsends mailwp_mail()called directly
• cacheobject cachewp_cache_get()one call below wp_site_admin_email_change_notification()
• serializeserialisationmaybe_unserialize()one call below wp_site_admin_email_change_notification()

Further down the call graph this can also reach query 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 · 2 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while wp_site_admin_email_change_notification() runs, in this order:

1. 1
   apply_filters( send_site_admin_email_change_email )filterline 8302 (+17 into the body)

   Filters whether to send the site admin email change notification email.

2. 2
   apply_filters( site_admin_email_change_email )filterline 8355 (+70 into the body)

   Filters the contents of the email notification sent when the site admin email address is changed.

Uses · 6

• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• wp_specialchars_decode()Converts a number of HTML entities into their special characters.
• get_option()Retrieves an option value based on an option name.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• wp_mail()Sends an email, similar to PHP's mail function.

Source code

View on Trac ↗View on GitHub ↗

8285function wp_site_admin_email_change_notification( $old_email, $new_email, $option_name ) {8286	$send = true;8287 8288	// Don't send the notification for an empty email address or the default 'admin_email' value.8289	if ( empty( $old_email ) || '[email protected]' === $old_email ) {8290		$send = false;8291	}8292 8293	/**8294	 * Filters whether to send the site admin email change notification email.8295	 *8296	 * @since 4.9.08297	 *8298	 * @param bool   $send      Whether to send the email notification.8299	 * @param string $old_email The old site admin email address.8300	 * @param string $new_email The new site admin email address.8301	 */8302	$send = apply_filters( 'send_site_admin_email_change_email', $send, $old_email, $new_email );8303 8304	if ( ! $send ) {8305		return;8306	}8307 8308	/* translators: Do not translate OLD_EMAIL, NEW_EMAIL, SITENAME, SITEURL: those are placeholders. */8309	$email_change_text = __(8310		'Hi,8311 8312This notice confirms that the admin email address was changed on ###SITENAME###.8313 8314The new admin email address is ###NEW_EMAIL###.8315 8316This email has been sent to ###OLD_EMAIL###8317 8318Regards,8319All at ###SITENAME###8320###SITEURL###'8321	);8322 8323	$email_change_email = array(8324		'to'      => $old_email,8325		/* translators: Site admin email change notification email subject. %s: Site title. */8326		'subject' => __( '[%s] Admin Email Changed' ),8327		'message' => $email_change_text,8328		'headers' => '',8329	);8330 8331	// Get site name.8332	$site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );8333 8334	/**8335	 * Filters the contents of the email notification sent when the site admin email address is changed.8336	 *8337	 * @since 4.9.08338	 *8339	 * @param array $email_change_email {8340	 *     Used to build wp_mail().8341	 *8342	 *     @type string $to      The intended recipient.8343	 *     @type string $subject The subject of the email.8344	 *     @type string $message The content of the email.8345	 *         The following strings have a special meaning and will get replaced dynamically:8346	 *          - `###OLD_EMAIL###` The old site admin email address.8347	 *          - `###NEW_EMAIL###` The new site admin email address.8348	 *          - `###SITENAME###`  The name of the site.8349	 *          - `###SITEURL###`   The URL to the site.8350	 *     @type string $headers Headers.8351	 * }8352	 * @param string $old_email The old site admin email address.8353	 * @param string $new_email The new site admin email address.8354	 */8355	$email_change_email = apply_filters( 'site_admin_email_change_email', $email_change_email, $old_email, $new_email );8356 8357	$email_change_email['message'] = str_replace( '###OLD_EMAIL###', $old_email, $email_change_email['message'] );8358	$email_change_email['message'] = str_replace( '###NEW_EMAIL###', $new_email, $email_change_email['message'] );8359	$email_change_email['message'] = str_replace( '###SITENAME###', $site_name, $email_change_email['message'] );8360	$email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );8361 8362	wp_mail(8363		$email_change_email['to'],8364		sprintf(

Changelog

Introduced in 4.9.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/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.