WP_Automatic_Updater::send_plugin_theme_email( string $type, array $successful_updates, array $failed_updates )

Compatibility

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

Parameters

$typestring

The type of email to send. Can be one of 'success', 'fail', 'mixed'.

$successful_updatesarray

A list of updates that succeeded.

$failed_updatesarray

A list of updates that failed.

Performance profile

How much work a call to WP_Automatic_Updater::send_plugin_theme_email() 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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

141–207

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

Plugin surface

1 hook

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

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• querycontent queryget_user_by()called directly
• hookthird-party callbacksapply_filters()called directly
• mailsends mailwp_mail()called directly
• cacheobject cachewp_cache_get()one call below WP_Automatic_Updater::send_plugin_theme_email()
• serializeserialisationmaybe_unserialize()one call below WP_Automatic_Updater::send_plugin_theme_email()

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 · 88 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

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

1. 1
   apply_filters( auto_plugin_theme_update_email )filterline 1541 (+306 into the body)

   Filters the email sent following an automatic background update for plugins and themes.

Uses · 15

• get_option()Retrieves an option value based on an option name.
• get_user_by()Retrieves user info by a given field.
• get_site_option()Retrieve an option value for the current network based on name of option.
• switch_to_user_locale()Switches the translations according to the given user's locale.
• switch_to_locale()Switches the translations according to the given locale.
• get_locale()Retrieves the current locale.
• __()Retrieves the translation of $text.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• esc_url()Checks and cleans a URL.
• admin_url()Retrieves the URL to the admin area for the current site.
• wp_specialchars_decode()Converts a number of HTML entities into their special characters.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• WP_Automatic_Updater::after_plugin_theme_update()Checks whether an email should be sent after attempting plugin or theme updates.

Source code

View on Trac ↗View on GitHub ↗

1235	protected function send_plugin_theme_email( $type, $successful_updates, $failed_updates ) {1236		// No updates were attempted.1237		if ( empty( $successful_updates ) && empty( $failed_updates ) ) {1238			return;1239		}1240 1241		$unique_failures     = false;1242		$past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );1243 1244		/*1245		 * When only failures have occurred, an email should only be sent if there are unique failures.1246		 * A failure is considered unique if an email has not been sent for an update attempt failure1247		 * to a plugin or theme with the same new_version.1248		 */1249		if ( 'fail' === $type ) {1250			foreach ( $failed_updates as $update_type => $failures ) {1251				foreach ( $failures as $failed_update ) {1252					if ( ! isset( $past_failure_emails[ $failed_update->item->{$update_type} ] ) ) {1253						$unique_failures = true;1254						continue;1255					}1256 1257					// Check that the failure represents a new failure based on the new_version.1258					if ( version_compare( $past_failure_emails[ $failed_update->item->{$update_type} ], $failed_update->item->new_version, '<' ) ) {1259						$unique_failures = true;1260					}1261				}1262			}1263 1264			if ( ! $unique_failures ) {1265				return;1266			}1267		}1268 1269		$admin_user = get_user_by( 'email', get_site_option( 'admin_email' ) );1270 1271		if ( $admin_user ) {1272			$switched_locale = switch_to_user_locale( $admin_user->ID );1273		} else {1274			$switched_locale = switch_to_locale( get_locale() );1275		}1276 1277		$body               = array();1278		$successful_plugins = ( ! empty( $successful_updates['plugin'] ) );1279		$successful_themes  = ( ! empty( $successful_updates['theme'] ) );1280		$failed_plugins     = ( ! empty( $failed_updates['plugin'] ) );1281		$failed_themes      = ( ! empty( $failed_updates['theme'] ) );1282 1283		switch ( $type ) {1284			case 'success':1285				if ( $successful_plugins && $successful_themes ) {1286					/* translators: %s: Site title. */1287					$subject = __( '[%s] Some plugins and themes have automatically updated' );1288					$body[]  = sprintf(1289						/* translators: %s: Home URL. */1290						__( 'Howdy! Some plugins and themes have automatically updated to their latest versions on your site at %s. No further action is needed on your part.' ),1291						home_url()1292					);1293				} elseif ( $successful_plugins ) {1294					/* translators: %s: Site title. */1295					$subject = __( '[%s] Some plugins were automatically updated' );1296					$body[]  = sprintf(1297						/* translators: %s: Home URL. */1298						__( 'Howdy! Some plugins have automatically updated to their latest versions on your site at %s. No further action is needed on your part.' ),1299						home_url()1300					);1301				} else {1302					/* translators: %s: Site title. */1303					$subject = __( '[%s] Some themes were automatically updated' );1304					$body[]  = sprintf(1305						/* translators: %s: Home URL. */1306						__( 'Howdy! Some themes have automatically updated to their latest versions on your site at %s. No further action is needed on your part.' ),1307						home_url()1308					);1309				}1310 1311				break;1312			case 'fail':1313			case 'mixed':1314				if ( $failed_plugins && $failed_themes ) {

Changelog

Introduced in 5.5.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-admin/includes/class-wp-automatic-updater.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.