W3cubDocs

/WordPress

WP_Recovery_Mode_Email_Service::maybe_send_recovery_mode_email( int $rate_limit, array $error, array $extension )

Sends the recovery mode email if the rate limit has not been sent.

Parameters

$rate_limit

(int) (Required) Number of seconds before another email can be sent.

$error

(array) (Required) Error details from error_get_last()

$extension

(array) (Required) The extension that caused the error.

  • 'slug'
    (string) The extension slug. The plugin or theme's directory.
  • 'type'
    (string) The extension type. Either 'plugin' or 'theme'.

Return

(true|WP_Error) True if email sent, WP_Error otherwise.

Source

File: wp-includes/class-wp-recovery-mode-email-service.php 

public function maybe_send_recovery_mode_email( $rate_limit, $error, $extension ) {

		$last_sent = get_option( self::RATE_LIMIT_OPTION );

		if ( ! $last_sent || time() > $last_sent + $rate_limit ) {
			if ( ! update_option( self::RATE_LIMIT_OPTION, time() ) ) {
				return new WP_Error( 'storage_error', __( 'Could not update the email last sent time.' ) );
			}

			$sent = $this->send_recovery_mode_email( $rate_limit, $error, $extension );

			if ( $sent ) {
				return true;
			}

			return new WP_Error(
				'email_failed',
				sprintf(
					/* translators: %s: mail() */
					__( 'The email could not be sent. Possible reason: your host may have disabled the %s function.' ),
					'mail()'
				)
			);
		}

		$err_message = sprintf(
			/* translators: 1. Last sent as a human time diff, 2. Wait time as a human time diff. */
			__( 'A recovery link was already sent %1$s ago. Please wait another %2$s before requesting a new email.' ),
			human_time_diff( $last_sent ),
			human_time_diff( $last_sent + $rate_limit )
		);

		return new WP_Error( 'email_sent_already', $err_message );
	}

Uses

Uses Description
wp-includes/class-wp-recovery-mode-email-service.php: WP_Recovery_Mode_Email_Service::send_recovery_mode_email()

Sends the Recovery Mode email to the site admin email address.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: human_time_diff()

Determines the difference between two timestamps.
wp-includes/option.php: update_option()

Updates the value of an option that was already added.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

Changelog

Version Description
5.2.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_recovery_mode_email_service/maybe_send_recovery_mode_email