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.
  1. $allow = apply_filters( 'allow_password_reset', $allow, $user_id ); 
  2.  
  3. if ( !empty( $allow ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the allow_password_reset callback 
  2. function filter_allow_password_reset( $allow, $user_id ) { 
  3. // make filter magic happen here... 
  4. return $allow
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'allow_password_reset', 'filter_allow_password_reset', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'allow_password_reset', 'filter_allow_password_reset', 10, 2 ); 

Defined (1)

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

/wp-includes/user.php  
  1. $allow = apply_filters( 'allow_password_reset', $allow, $user->ID );