[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

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

Error Protection API: WP_Recovery_Mode_Email_Link class

File Size: 352 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 wp-admin/includes/plugin.php

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

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

return: true|WP_Error True if email sent, WP_Error otherwise.
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. {

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.

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

return: bool Whether the email was sent successfully.
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.

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.

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

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

get_plugin( $extension )   X-Ref
Return the details for a single plugin based on the extension data from an error.

return: bool|array A plugin array {@see get_plugins()} or `false` if no plugin was found.
param: array $extension The extension that caused the error.

get_debug( $extension )   X-Ref
Return debug information in an easy to manipulate format.

return: array An associated array of debug information.
param: array $extension The extension that caused the error.



Generated: Fri Oct 25 08:20:01 2019 Cross-referenced by PHPXref 0.7