apply_filters( 'retrieve_password_message', string $message, string $key, string $user_login, WP_User $user_data )
- Since
- 2.8.0, 4.1.0
Filters the message body of the password reset mail.
Description
If the filtered message is empty, the password reset email will not be sent.
Compatibility
- WordPress
- since 4.1.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
$messagestring- Email message.
$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:3417retrieve_password()
Source code
* * @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. */ $message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data ); // Short-circuit on falsey $message value for backwards compatibility. if ( ! $message ) { return true; }Changelog
Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
4.1.0
Added
$user_login and $user_data parameters.from the docblock2.8.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.