WP_Recovery_Mode_Email_Service::send_recovery_mode_email( int $rate_limit, array $error, array $extension ): bool

Parameters

$rate_limitint

Number of seconds before another email can be sent.

$errorarray

Error details from error_get_last().

$extensionarray

The extension that caused the error.

• $slugstring

  The extension slug. The directory of the plugin or theme.

• $typestring

  The extension type. Either 'plugin' or 'theme'.

Return

bool

Whether the email was sent successfully.

Hooks fired · 3

3 hooks fire while WP_Recovery_Mode_Email_Service::send_recovery_mode_email() runs, in this order:

1. 1
   apply_filters( recovery_email_support_info )filterline 141 (+27 into the body)

   Filters the support message sent with the the fatal error protection email.

2. 2
   apply_filters( recovery_email_debug_info )filterline 150 (+36 into the body)

   Filters the debug information included in the fatal error protection email.

3. 3
   apply_filters( recovery_mode_email )filterline 223 (+109 into the body)

   Filters the contents of the Recovery Mode email.

Uses · 15

• wp_specialchars_decode()Converts a number of HTML entities into their special characters.
• get_option()Retrieves an option value based on an option name.
• switch_to_locale()Switches the translations according to the given locale.
• get_locale()Retrieves the current locale.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• wp_get_extension_error_description()Get a human readable description of an extension's error.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• human_time_diff()Determines the difference between two timestamps.
• 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.
• restore_previous_locale()Restores the translations according to the previous locale.

Used by · 1

• WP_Recovery_Mode_Email_Service::maybe_send_recovery_mode_email()Sends the recovery mode email if the rate limit has not been sent.

Source

View on Trac ↗View on GitHub ↗

114	private function send_recovery_mode_email( $rate_limit, $error, $extension ) {115 116		$url      = $this->link_service->generate_url();117		$blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );118 119		$switched_locale = switch_to_locale( get_locale() );120 121		if ( $extension ) {122			$cause   = $this->get_cause( $extension );123			$details = wp_strip_all_tags( wp_get_extension_error_description( $error ) );124 125			if ( $details ) {126				$header  = __( 'Error Details' );127				$details = "\n\n" . $header . "\n" . str_pad( '', strlen( $header ), '=' ) . "\n" . $details;128			}129		} else {130			$cause   = '';131			$details = '';132		}133 134		/**135		 * Filters the support message sent with the the fatal error protection email.136		 *137		 * @since 5.2.0138		 *139		 * @param string $message The Message to include in the email.140		 */141		$support = apply_filters( 'recovery_email_support_info', __( 'Please contact your host for assistance with investigating this issue further.' ) );142 143		/**144		 * Filters the debug information included in the fatal error protection email.145		 *146		 * @since 5.3.0147		 *148		 * @param array $message An associative array of debug information.149		 */150		$debug = apply_filters( 'recovery_email_debug_info', $this->get_debug( $extension ) );151 152		/* translators: Do not translate LINK, EXPIRES, CAUSE, DETAILS, SITEURL, PAGEURL, SUPPORT. DEBUG: those are placeholders. */153		$message = __(154			'Howdy!155 156WordPress has a built-in feature that detects when a plugin or theme causes a fatal error on your site, and notifies you with this automated email.157###CAUSE###158First, visit your website (###SITEURL###) and check for any visible issues. Next, visit the page where the error was caught (###PAGEURL###) and check for any visible issues.159 160###SUPPORT###161 162If your site appears broken and you can\'t access your dashboard normally, WordPress now has a special "recovery mode". This lets you safely login to your dashboard and investigate further.163 164###LINK###165 166To keep your site safe, this link will expire in ###EXPIRES###. Don\'t worry about that, though: a new link will be emailed to you if the error occurs again after it expires.167 168When seeking help with this issue, you may be asked for some of the following information:169###DEBUG###170 171###DETAILS###'172		);173		$message = str_replace(174			array(175				'###LINK###',176				'###EXPIRES###',177				'###CAUSE###',178				'###DETAILS###',179				'###SITEURL###',180				'###PAGEURL###',181				'###SUPPORT###',182				'###DEBUG###',183			),184			array(185				$url,186				human_time_diff( time() + $rate_limit ),187				$cause ? "\n{$cause}\n" : "\n",188				$details,189				home_url( '/' ),190				home_url( $_SERVER['REQUEST_URI'] ),191				$support,192				implode( "\r\n", $debug ),193			),

History

Introduced in 5.2.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-includes/class-wp-recovery-mode-email-service.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.