wppaste
WordPress

apply_filters( 'recovery_mode_email', array $email, string $url )

Since
5.2.0, 5.6.0
Filters the contents of the Recovery Mode email.

Compatibility

WordPress
since 5.6.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$emailarray
{ Used to build a call to wp_mail().
@type string|array $to Array or comma-separated list of email addresses to send message.
@type string $subject Email subject @type string $message Message contents @type string|array $headers Optional. Additional headers.
@type string|array $attachments Optional. Files to attach.
}
  • $tostring|array

    Array or comma-separated list of email addresses to send message.
  • $subjectstring

    Email subject @type string $message Message contents @type string|array $headers Optional. Additional headers.
  • $attachmentsstring|array

    Optional. Files to attach.
$urlstring
URL to enter recovery mode.

Where this hook fires · 1

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

Source code

		 *     @type string       $message     Message contents		 *     @type string|array $headers     Optional. Additional headers.		 *     @type string|array $attachments Optional. Files to attach.		 * }		 * @param string $url   URL to enter recovery mode.		 */		$email = apply_filters( 'recovery_mode_email', $email, $url ); 		$sent = wp_mail(			$email['to'],			wp_specialchars_decode( sprintf( $email['subject'], $blogname ) ),			$email['message'],			$email['headers'],

Changelog

Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

5.6.0
The $email argument includes the attachments key.from the docblock
5.2.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.7.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.