WP_Automatic_Updater::send_email( string $type, object $core_update, mixed $result = null )

Parameters

$typestring

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

$core_updateobject

The update offer that was attempted.

$resultmixedoptional

The result for the core update. Can be WP_Error.Default: null

Hooks fired · 2

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

1. 1
   apply_filters( auto_core_update_send_email )filterline 935 (+37 into the body)

   Filters whether to send an email following an automatic background core update.

2. 2
   apply_filters( auto_core_update_email )filterline 1147 (+249 into the body)

   Filters the email sent following an automatic background core update.

Uses · 20

• update_site_option()Updates the value of an option that was already added for the current network.
• get_site_option()Retrieve an option value for the current network based on name of option.
• get_preferred_from_update_core()Selects the first update version from the update_core option.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_user_by()Retrieves user info by a given field.
• 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.
• 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.

Used by · 2

• WP_Automatic_Updater::after_core_update()Checks whether to send an email and avoid processing future updates after attempting a core update.
• WP_Automatic_Updater::send_core_update_notification_email()Notifies an administrator of a core update.

Source

View on Trac ↗View on GitHub ↗

898	protected function send_email( $type, $core_update, $result = null ) {899		update_site_option(900			'auto_core_update_notified',901			array(902				'type'      => $type,903				'email'     => get_site_option( 'admin_email' ),904				'version'   => $core_update->current,905				'timestamp' => time(),906			)907		);908 909		$next_user_core_update = get_preferred_from_update_core();910 911		// If the update transient is empty, use the update we just performed.912		if ( ! $next_user_core_update ) {913			$next_user_core_update = $core_update;914		}915 916		if ( 'upgrade' === $next_user_core_update->response917			&& version_compare( $next_user_core_update->version, $core_update->version, '>' )918		) {919			$newer_version_available = true;920		} else {921			$newer_version_available = false;922		}923 924		/**925		 * Filters whether to send an email following an automatic background core update.926		 *927		 * @since 3.7.0928		 *929		 * @param bool   $send        Whether to send the email. Default true.930		 * @param string $type        The type of email to send. Can be one of931		 *                            'success', 'fail', 'critical'.932		 * @param object $core_update The update offer that was attempted.933		 * @param mixed  $result      The result for the core update. Can be WP_Error.934		 */935		if ( 'manual' !== $type && ! apply_filters( 'auto_core_update_send_email', true, $type, $core_update, $result ) ) {936			return;937		}938 939		$admin_user = get_user_by( 'email', get_site_option( 'admin_email' ) );940 941		if ( $admin_user ) {942			$switched_locale = switch_to_user_locale( $admin_user->ID );943		} else {944			$switched_locale = switch_to_locale( get_locale() );945		}946 947		switch ( $type ) {948			case 'success': // We updated.949				/* translators: Site updated notification email subject. 1: Site title, 2: WordPress version. */950				$subject = __( '[%1$s] Your site has updated to WordPress %2$s' );951				break;952 953			case 'fail':   // We tried to update but couldn't.954			case 'manual': // We can't update (and made no attempt).955				/* translators: Update available notification email subject. 1: Site title, 2: WordPress version. */956				$subject = __( '[%1$s] WordPress %2$s is available. Please update!' );957				break;958 959			case 'critical': // We tried to update, started to copy files, then things went wrong.960				/* translators: Site down notification email subject. 1: Site title. */961				$subject = __( '[%1$s] URGENT: Your site may be down due to a failed update' );962				break;963 964			default:965				return;966		}967 968		// If the auto-update is not to the latest version, say that the current version of WP is available instead.969		$version = 'success' === $type ? $core_update->current : $next_user_core_update->current;970		$subject = sprintf( $subject, wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), $version );971 972		$body = '';973 974		switch ( $type ) {975			case 'success':976				$body .= sprintf(977					/* translators: 1: Home URL, 2: WordPress version. */

History

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