[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-wp-recovery-mode-email-service.php (summary)

Error Protection API: WP_Recovery_Mode_Email_Link class

File Size: 275 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 6 functions

  __construct()
  maybe_send_recovery_mode_email()
  clear_rate_limit()
  send_recovery_mode_email()
  get_recovery_mode_email_address()
  get_cause()

Functions
Functions that are not part of a class:

__construct( WP_Recovery_Mode_Link_Service $link_service )   X-Ref
WP_Recovery_Mode_Email_Service constructor.

param: WP_Recovery_Mode_Link_Service $link_service
since: 5.2.0

maybe_send_recovery_mode_email( $rate_limit, $error, $extension )   X-Ref
Sends the recovery mode email if the rate limit has not been sent.

param: int   $rate_limit Number of seconds before another email can be sent.
param: array $error      Error details from {@see error_get_last()}
param: array $extension  The extension that caused the error. {
return: true|WP_Error True if email sent, WP_Error otherwise.
since: 5.2.0

clear_rate_limit()   X-Ref
Clears the rate limit, allowing a new recovery mode email to be sent immediately.

return: bool True on success, false on failure.
since: 5.2.0

send_recovery_mode_email( $rate_limit, $error, $extension )   X-Ref
Sends the Recovery Mode email to the site admin email address.

param: int   $rate_limit Number of seconds before another email can be sent.
param: array $error      Error details from {@see error_get_last()}
param: array $extension  Extension that caused the error.
return: bool Whether the email was sent successfully.
since: 5.2.0

get_recovery_mode_email_address()   X-Ref
Gets the email address to send the recovery mode link to.

return: string Email address to send recovery mode link to.
since: 5.2.0

get_cause( $extension )   X-Ref
Gets the description indicating the possible cause for the error.

param: array $extension The extension that caused the error.
return: string Message about which extension caused the error.
since: 5.2.0



Generated: Mon Jul 22 01:00:03 2019 Cross-referenced by PHPXref 0.7.1