ClassicPress logo
Skip to content
Filter by type:
Browse: Home / Functions / retrieve_password / retrieve_password_message

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) Default mail message.

$key

(string) The activation key.

$user_login

(string) The username for the user.

$user_data

(WP_User) WP_User object.


Source

File: wp-login.php

View on GitHub


Related

Used By

Used By
Used By Description
wp-login.php: retrieve_password()

Handles sending password retrieval email to user.


Changelog

Changelog
Version Description
WP-4.1.0 Added $user_login and $user_data parameters.
WP-2.8.0 Introduced.
ClassicPress Documentation • Made with ClassicPress
Privacy Policy