How to use password_reset_key_expired filter in WordPress

password_reset_key_expired filter

Filters the return value of check_password_reset_key() when an old-style key is used.

To use password_reset_key_expired filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

At WePlugins, we always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_password_reset_key_expired_defaults which takes 2 parameters and we registered using add_filter. The first parameter password_reset_key_expired is the name of the hook, the second parameter weplugins_modify_password_reset_key_expired_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook, so you can use remove_filter to remove password_reset_key_expired filter.

Parameters

Below are the 2 parameters required to use this hook.

• $return: (WP_Error) A WP_Error object denoting an expired key. Return a WP_User object to validate the key.
• $user_id: (int) The matched user ID.

Example 1: Applying the Filter

Below is an example of how you can use this hook.

    function weplugins_modify_password_reset_key_expired_defaults($return, $user_id) { 
        // Update the $return variable according to your website requirements and return this variable.
        // You can modify the $return variable conditionally too if you want.
        return $return; 
    }
    // add the filter
    add_filter( "password_reset_key_expired", "weplugins_modify_password_reset_key_expired_defaults", 10, 2 );
    

Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "password_reset_key_expired", "weplugins_modify_password_reset_key_expired_defaults", 10, 2 );
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Example 3: Custom Validation Logic

Here’s another example showcasing custom validation logic using the password_reset_key_expired filter.

    function weplugins_custom_validation($return, $user_id) {
        if ( /* some condition */ ) {
            // Perform custom validation and modify $return if necessary
        }
        return $return;
    }
    add_filter('password_reset_key_expired', 'weplugins_custom_validation', 10, 2);
    

Contact Us

If you’re having any trouble using this hook, please contact us and we’d be happy to assist you.