apply_filters( 'retrieve_password_message', string $message, string $key, string $user_login, WP_User $user_data )

Filters the message body of the password reset mail.

Description

If the filtered message is empty, the password reset email will not be sent.

Parameters

$message

(string) Email message.

$key

(string) The activation key.

$user_login

(string) The username for the user.

$user_data

(WP_User) WP_User object.

Source

File: wp-includes/user.php

View on Trac

Used By

Used By Description
wp-includes/user.php: retrieve_password()

Handles sending a password retrieval email to a user.

Changelog

Version Description
4.1.0 Added $user_login and $user_data parameters.
2.8.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/retrieve_password_message