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

125–210

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

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
• 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 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 · 60 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 1522 (+298 into the body)

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

Uses · 10

• get_option()Retrieves an option value based on an option name.
• __()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.
• get_site_option()Retrieve an option value for the current network based on name of option.
• 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.
• update_option()Updates the value of an option that was already added.

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 ↗

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

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