retrieve_password_message WordPress Filter Hook
The retrieve_password_message hook is used to filter the message that is sent to a user when they request a password reset. This hook can be used to customize the message for a specific user or to modify the message for all users.
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
Source
File: wp-includes/user.php
Changelog
| Version | Description |
|---|---|
| 4.1.0 | Added $user_login and $user_data parameters. |
| 2.8.0 | Introduced. |