Filter hook 'retrieve_password_message'
in WP Core File wp-includes/user.php at line 3263
Description
Filters the message body of the password reset mail. If the filtered message is empty, the password reset email will not be sent.
Occurrences
| Filename |
Line Number |
| wp-includes/user.php |
3263 |
Parameters
| Type |
Name |
Description |
| string |
$message |
Email message. |
| string |
$key |
The activation key. |
| string |
$user_login |
The username for the user. |
| WP_User |
$user_data |
WP_User object. |
PHP Doc
/**
* Filters the message body of the password reset mail.
*
* If the filtered message is empty, the password reset email will not be sent.
*
* @since 2.8.0
* @since 4.1.0 Added `$user_login` and `$user_data` parameters.
*
* @param string $message Email message.
* @param string $key The activation key.
* @param string $user_login The username for the user.
* @param WP_User $user_data WP_User object.
*/