How to use login_site_html_link filter in WordPress

login_site_html_link filter

Filter the “Go to site” link displayed in the login page footer.

To use the login_site_html_link 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 weplugins_modify_login_site_html_link_defaults which takes 1 parameter and we registered it using add_filter. The first parameter login_site_html_link is the name of the hook, the second parameter weplugins_modify_login_site_html_link_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_site_html_link filter.

Parameters

Below the 1 parameter is required to use this hook.

• $link: (string) HTML link to the home URL of the current site.

Live Example 1

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

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

Live Example 2

Another example where we append some custom text to the link.

    function weplugins_custom_login_site_link($link) { 
        return $link . ' - Welcome to our site!'; 
    }
    // add the filter
    add_filter("login_site_html_link", "weplugins_custom_login_site_link", 10, 1);
    

Live Example 3

To remove a hook callback, use the example below.

    function weplugins_modify_login_site_html_link_defaults($link) { 
        return $link; 
    }
    // add the filter
    add_filter("login_site_html_link", "weplugins_modify_login_site_html_link_defaults", 10, 1);
    // remove the filter
    remove_filter("login_site_html_link", "weplugins_modify_login_site_html_link_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, please contact our WordPress Development Team and we’d be happy to assist you.