PHPXRef 0.7.1 : WordPress : Detail view of class-wp-recovery-mode-email-service.php

Error Protection API: WP_Recovery_Mode_Email_Link class

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

Defines 8 functions

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

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 `error_get_last()`.
param: array $extension {
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 `error_get_last()`.
param: array $extension {
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 {
return: string Message about which extension caused the error.
since: 5.2.0

get_plugin( $extension ) X-Ref

Return the details for a single plugin based on the extension data from an error.

param: array $extension {
return: array|false A plugin array {@see get_plugins()} or `false` if no plugin was found.
since: 5.3.0

get_debug( $extension ) X-Ref

Return debug information in an easy to manipulate format.

param: array $extension {
return: array An associative array of debug information.
since: 5.3.0

PHP Cross Reference of WordPress

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

Defines 8 functions