How to use application_password_failed_authentication action in WordPress

application_password_failed_authentication action

Fires when an application password failed to authenticate the user.

To use application_password_failed_authentication 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_application_password_failed_authentication_event which takes 1 parameter and we registered it using add_action. The first parameter application_password_failed_authentication is the name of the hook, the second parameter weplugins_execute_on_application_password_failed_authentication_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 application_password_failed_authentication action.

Parameters

Below the 1 parameter is required to use this hook.

• $error : (WP_Error) The authentication error.

Live Example

do_action( 'application_password_failed_authentication', WP_Error $error )

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

    function weplugins_execute_on_application_password_failed_authentication_event($error){
        // You can write code here to be executed when this action occurs in WordPress. 
        // Use the parameters received in the function arguments & implement the required 
        // additional custom functionality according to your website requirements.
    }
    // add the action
    add_action( "application_password_failed_authentication", "weplugins_execute_on_application_password_failed_authentication_event" , 10, 1);
    

Example 1: Logging the Authentication Error

If you want to log the authentication errors for later debugging, you can use the following code snippet:

    function weplugins_log_authentication_error($error) {
        error_log('Authentication failed: ' . $error->get_error_message());
    }
    add_action('application_password_failed_authentication', 'weplugins_log_authentication_error', 10, 1);
    

Example 2: Display Custom Error Message

If you want to display a custom error message to the user upon authentication failure, you can use the following code snippet:

    function weplugins_custom_error_message($error) {
        echo 'Custom Error: Authentication has failed. Please try again.';
    }
    add_action('application_password_failed_authentication', 'weplugins_custom_error_message', 10, 1);
    

Example 3: Notify Admin on Authentication Failure

If you want to notify the admin via email whenever there’s an authentication failure, you can use the following code snippet:

    function weplugins_notify_admin_on_auth_failure($error) {
        wp_mail('admin@example.com', 'Authentication Failure', 'An authentication attempt has failed. Error: ' . $error->get_error_message());
    }
    add_action('application_password_failed_authentication', 'weplugins_notify_admin_on_auth_failure', 10, 1);
    

To remove a hook callback, use the example below.

    remove_action( "application_password_failed_authentication", "weplugins_execute_on_application_password_failed_authentication_event", 10, 1 );
    

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

Contact Us

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