authenticate

The Ultimate Member authenticate hook.

Description

apply_filters( 'authenticate', (null) $null, (string) $user_name, (unknown) $args_user_password ); 

Parameters (3)

0. $null (null) => null
The null.
1. $user_name (string)
The user name.
2. $args_user_password (unknown)
The args user password.

Usage

To run the hook, copy the example below.
  1. $null = apply_filters( 'authenticate', $null, $user_name, $args_user_password ); 
  2.  
  3. if ( !empty( $null ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the authenticate callback 
  2. function filter_authenticate( $null, $user_name, $args_user_password ) { 
  3. // make filter magic happen here... 
  4. return $null
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'authenticate', 'filter_authenticate', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'authenticate', 'filter_authenticate', 10, 3 ); 

Defined (1)

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

/core/um-actions-login.php  
  1. $user = apply_filters( 'authenticate', null, $user_name, $args['user_password'] );