WP_Automatic_Updater::send_debug_email()

Compatibility

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

Performance profile

How much work a call to WP_Automatic_Updater::send_debug_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 how much data it finds.

Instructions

102–142

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

Plugin surface

1 hook

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

• querycontent queryget_user_by()called directly
• optionnetwork optionget_site_option()called directly
• hookthird-party callbacksapply_filters()called directly
• mailsends mailwp_mail()called directly

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

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( automatic_updates_debug_email )filterline 1741 (+182 into the body)

   Filters the debug email that can be sent following an automatic background core update.

Uses · 16

• 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.
• network_home_url()Retrieves the home URL for the current network.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_list_filter()Filters a list of objects, based on a set of key => value arguments.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• get_bloginfo()Retrieves information about the current site.
• wp_specialchars_decode()Converts a number of HTML entities into their special characters.

Used by · 1

• WP_Automatic_Updater::run()Kicks off the background update process, looping through all pending updates.

Source code

View on Trac ↗View on GitHub ↗

1559	protected function send_debug_email() {1560		$admin_user = get_user_by( 'email', get_site_option( 'admin_email' ) );1561 1562		if ( $admin_user ) {1563			$switched_locale = switch_to_user_locale( $admin_user->ID );1564		} else {1565			$switched_locale = switch_to_locale( get_locale() );1566		}1567 1568		$body     = array();1569		$failures = 0;1570 1571		/* translators: %s: Network home URL. */1572		$body[] = sprintf( __( 'WordPress site: %s' ), network_home_url( '/' ) );1573 1574		// Core.1575		if ( isset( $this->update_results['core'] ) ) {1576			$result = $this->update_results['core'][0];1577 1578			if ( $result->result && ! is_wp_error( $result->result ) ) {1579				/* translators: %s: WordPress version. */1580				$body[] = sprintf( __( 'SUCCESS: WordPress was successfully updated to %s' ), $result->name );1581			} else {1582				/* translators: %s: WordPress version. */1583				$body[] = sprintf( __( 'FAILED: WordPress failed to update to %s' ), $result->name );1584				++$failures;1585			}1586 1587			$body[] = '';1588		}1589 1590		// Plugins, Themes, Translations.1591		foreach ( array( 'plugin', 'theme', 'translation' ) as $type ) {1592			if ( ! isset( $this->update_results[ $type ] ) ) {1593				continue;1594			}1595 1596			$success_items = wp_list_filter( $this->update_results[ $type ], array( 'result' => true ) );1597 1598			if ( $success_items ) {1599				$messages = array(1600					'plugin'      => __( 'The following plugins were successfully updated:' ),1601					'theme'       => __( 'The following themes were successfully updated:' ),1602					'translation' => __( 'The following translations were successfully updated:' ),1603				);1604 1605				$body[] = $messages[ $type ];1606				foreach ( wp_list_pluck( $success_items, 'name' ) as $name ) {1607					/* translators: %s: Name of plugin / theme / translation. */1608					$body[] = ' * ' . sprintf( __( 'SUCCESS: %s' ), $name );1609				}1610			}1611 1612			if ( $success_items !== $this->update_results[ $type ] ) {1613				// Failed updates.1614				$messages = array(1615					'plugin'      => __( 'The following plugins failed to update:' ),1616					'theme'       => __( 'The following themes failed to update:' ),1617					'translation' => __( 'The following translations failed to update:' ),1618				);1619 1620				$body[] = $messages[ $type ];1621 1622				foreach ( $this->update_results[ $type ] as $item ) {1623					if ( ! $item->result || is_wp_error( $item->result ) ) {1624						/* translators: %s: Name of plugin / theme / translation. */1625						$body[] = ' * ' . sprintf( __( 'FAILED: %s' ), $item->name );1626						++$failures;1627					}1628				}1629			}1630 1631			$body[] = '';1632		}1633 1634		if ( '' !== get_bloginfo( 'name' ) ) {1635			$site_title = wp_specialchars_decode( get_bloginfo( 'name' ), ENT_QUOTES );1636		} else {1637			$site_title = parse_url( home_url(), PHP_URL_HOST );1638		}

Changelog

Introduced in 3.7.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.8.8 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.