How to use resetpass_form action in WordPress

resetpass_form action

Fires following the ‘Strength indicator’ meter in the user password reset form.

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

We at WePlugins 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_execute_on_resetpass_form_event which takes 1 parameter and we registered using add_action. The first parameter resetpass_form is the name of the hook, The second parameter weplugins_execute_on_resetpass_form_event 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_action to remove resetpass_form action.

Parameters

Below the 1 parameter is required to use this hook.

• $user : (WP_User) User object of the user whose password is being reset.

Live Example

do_action( 'resetpass_form', WP_User $user )

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

Example 1: Basic Usage

In this example, we simply log the user information when the password reset form is displayed.

	function weplugins_execute_on_resetpass_form_event($user){
	   // Log the user information
	   error_log(print_r($user, true));
	}
	// add the action
	add_action( "resetpass_form", "weplugins_execute_on_resetpass_form_event" , 10, 1);
	

Example 2: Display Custom Message

This example shows how to display a custom message in the password reset form.

	function weplugins_execute_on_resetpass_form_event($user){
	   echo "<p>Custom message for user: " . esc_html($user->user_login) . "</p>";
	}
	// add the action
	add_action( "resetpass_form", "weplugins_execute_on_resetpass_form_event" , 10, 1);
	

Example 3: Redirect User

In this example, we redirect the user to a custom URL after displaying the password reset form.

	function weplugins_execute_on_resetpass_form_event($user){
	   wp_redirect('https://custom-url.com');
	   exit;
	}
	// add the action
	add_action( "resetpass_form", "weplugins_execute_on_resetpass_form_event" , 10, 1);
	

To remove a hook callback, use the example below.

remove_action( "resetpass_form", "weplugins_execute_on_resetpass_form_event", 10, 1 );

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

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