How to use login_headerurl filter in WordPress

login_headerurl filter

Filters link URL of the header logo above login form.

To use login_headerurl 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_headerurl_defaults which takes 1 parameter and we registered using add_filter. The first parameter login_headerurl is the name of the hook, the second parameter modify_login_headerurl_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_headerurl filter.

Parameters

Below the 1 parameter is required to use this hook.

• $login_header_url : (string) Login header logo URL.

Live Example 1

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

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

Live Example 2

Here’s how you can remove a hook callback.

    remove_filter("login_headerurl", "weplugins_modify_login_headerurl_defaults", 10, 1);
    

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

Live Example 3

This example shows how to conditionally change the login header URL.

    function weplugins_conditional_login_headerurl($login_header_url) { 
        if (is_user_logged_in()) {
            $login_header_url = home_url('/dashboard');
        }
        return $login_header_url;
    }
    add_filter("login_headerurl", "weplugins_conditional_login_headerurl", 10, 1);