apply_filters( 'retrieve_password_notification_email', array $defaults, string $key, string $user_login, WP_User $user_data )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$defaultsarray

{ The default notification email arguments. Used to build wp_mail().
@type string $to The intended recipient - user email address.
@type string $subject The subject of the email.
@type string $message The body of the email.
@type string $headers The headers of the email.
}

• $tostring

  The intended recipient - user email address.

• $subjectstring

  The subject of the email.

• $messagestring

  The body of the email.

• $headersstring

  The headers of the email.

$keystring

The activation key.

$user_loginstring

The username for the user.

$user_dataWP_User

WP_User object.

Where this hook fires · 1

• wp-includes/user.php:3379retrieve_password()

Source code

View on Trac ↗View on GitHub ↗

3373	 *     @type string $headers The headers of the email.3374	 * }3375	 * @param string  $key        The activation key.3376	 * @param string  $user_login The username for the user.3377	 * @param WP_User $user_data  WP_User object.3378	 */3379	$notification_email = apply_filters( 'retrieve_password_notification_email', $defaults, $key, $user_login, $user_data );3380 3381	if ( $switched_locale ) {3382		restore_previous_locale();3383	}3384 3385	if ( is_array( $notification_email ) ) {

Changelog

Introduced in 6.0.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.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 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.