retrieve_password

Fires before a new password is retrieved.

Description

do_action( 'retrieve_password', (string) $user_user_login ); 

Parameters (1)

0. $user_user_login (string)
The user user login.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'retrieve_password', $user_user_login ); 
The following example is for adding a hook callback.
  1. // define the retrieve_password callback 
  2. function action_retrieve_password( $user_user_login ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'retrieve_password', 'action_retrieve_password', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'retrieve_password', 'action_retrieve_password', 10, 1 ); 

Defined (1)

The action is defined in the following location(s).

/wp-includes/user.php  
  1. do_action( 'retrieve_password', $user->user_login );