WordPress at a glance
filter is not described

retrieve_password_message filter-hook . WP 2.8.0

Filters the message body of the password reset mail.

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

Usage

add_filter( 'retrieve_password_message', 'filter_function_name_6544', 10, 4 );
function filter_function_name_6544( $message, $key, $user_login, $user_data ){
	// filter...

	return $message;
}
$message(string)
Default mail message.
$key(string)
The activation key.
$user_login(string)
The username for the user.
$user_data(WP_User)
WP_User object.

Notes

  • Since 4.1.0 Added $user_login and $user_data parameters.

Where the hook is called

retrieve_password()
wp-login.php 399
$message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data );

Where the hook is used (in WP core)

Does not used.