allow_password_reset

Filters whether to allow a password to be reset.

Description

apply_filters( 'allow_password_reset', (bool) $allow, (int) $user_id ); 

Parameters (2)

0. $allow (bool)

Whether to allow the password to be reset. Default true.

1. $user_id (int)

The ID of the user attempting to reset a password.

Usage

To run the hook, copy the example below.

$allow = apply_filters( 'allow_password_reset', $allow, $user_id ); 
                         
if ( !empty( $allow ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the allow_password_reset callback 
function filter_allow_password_reset( $allow, $user_id ) { 
    // make filter magic happen here... 
    return $allow; 
}; 
         
// add the filter 
add_filter( 'allow_password_reset', 'filter_allow_password_reset', 10, 2 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'allow_password_reset', 'filter_allow_password_reset', 10, 2 );