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.

// run the action 
do_action( 'wp_authenticate', $array ); 

The following example is for adding a hook callback.

// define the wp_authenticate callback 
function action_wp_authenticate( $array ) { 
    // make action magic happen here... 
}; 
         
// add the action 
add_action( 'wp_authenticate', 'action_wp_authenticate', 10, 1 ); 

To remove a hook callback, use the example below.

// remove the action 
remove_action( 'wp_authenticate', 'action_wp_authenticate', 10, 1 );