How to use login_headertext filter in WordPress

login_headertext Filter

Filters the link text of the header logo above the login form.

To use the login_headertext filter, first you have to register it using add_filter. You can write this code into the 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_headertext_defaults which takes 1 parameter and we registered it using add_filter. The first parameter login_headertext is the name of the hook, the second parameter modify_login_headertext_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 the login_headertext filter.

Parameters

Below the 1 parameter is required to use this hook.

• $login_header_text: (string) The login header logo link text.

Live Example 1: Customize Login Header Text

Below is an example of how you can customize the login header text.

    // Customize login header text.
    add_filter( 'login_headertext', 'weplugins_customize_login_headertext' );
    function weplugins_customize_login_headertext( $headertext ) {
        $headertext = esc_html__( 'Welcome to WordPress', 'plugin-textdomain' );
        return $headertext;
    }
    

Live Example 2: Modify Login Header Text Defaults

Below is an example of how you can modify the login header text defaults.

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

Live Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "login_headertext", "weplugins_modify_login_headertext_defaults", 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 or need any customization, please contact us.