WordPress at a glance
function is not described

WP_Recovery_Mode_Email_Service::maybe_send_recovery_mode_email() public WP 5.2.0

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

{} It's a method of the class: WP_Recovery_Mode_Email_Service{}

No Hooks.

Return

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

Usage

$WP_Recovery_Mode_Email_Service = new WP_Recovery_Mode_Email_Service();
$WP_Recovery_Mode_Email_Service->maybe_send_recovery_mode_email( $rate_limit, $error, $extension );
$rate_limit(int) (required)
Number of seconds before another email can be sent.
$error(array) (required)
Error details from {@see 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'.

Changelog

Since 5.2.0 Introduced.

Code of WP_Recovery_Mode_Email_Service::maybe_send_recovery_mode_email() WP 5.7.2

<?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 );
}