retrieve_password_key

This action is documented in wp-login.php.

Description

do_action( 'retrieve_password_key', (unknown) $user_user_login, (unknown) $key ); 

Parameters (2)

0. $user_user_login (unknown)
The user user login.
1. $key (unknown)
The key.

Usage

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

Defined (2)

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

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