wp_authenticate

Fires before the user is authenticated.

Description

do_action( 'wp_authenticate', (array) $array ); 

The variables passed to the callbacks are passed by reference, and can be modified by callback functions.

Parameters (1)

0. $array (array) => array( &$credentials['user_login'], &$credentials['user_password'] )
The array.

Usage

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

Defined (1)

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

/wp-includes/user.php  
  1. do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );