How to use login_message filter in WordPress

login_message filter

Filters the message to display above the login form.

To use the login_message 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.

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 modify_login_message_defaults which takes 1 parameter and we registered it using add_filter. The first parameter login_message is the name of the hook, the second parameter modify_login_message_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 login_message filter.

Parameters

Below the 1 parameter is required to use this hook.

• $message: (string) Login message text.

Live Example 1: Custom Login Message

In this example, we customize the login message based on certain conditions.

    add_filter( 'login_message', 'weplugins_custom_login_message' );
    function weplugins_custom_login_message( $message ) {
        $action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : '';
        $errors = new WP_Error();
        if ( isset( $_GET['key'] ) ) {
            $action = 'resetpass';
        }
        if ( isset( $_GET['checkemail'] ) ) {
            $message = '<p class="message">' . __( 'Check your email for the confirmation link.', 'text_domain' ) . '</p>';
        }
        return $message;
    }
    

Live Example 2: Basic Custom Message

Below is an example of how you can use this hook to modify the message.

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

Live Example 3: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "login_message", "weplugins_modify_login_message_defaults", 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.