login_url Filter
Filters the login URL.
To use the login_url 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_url_defaults which takes 3 parameters and we registered it using add_filter. The first parameter login_url is the name of the hook. The second parameter modify_login_url_defaults is the name of the function that 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_url filter.
Parameters
Below are the 3 parameters required to use this hook:
- $login_url: (string) The login URL. Not HTML-encoded.
- $redirect: (string) The path to redirect to on login, if supplied.
- $force_reauth: (bool) Whether to force reauthorization, even if a cookie is present.
Live Example 1
Here is an example of how to use this hook:
function weplugins_modify_login_url_defaults($login_url, $redirect, $force_reauth) {
// Update the $login_url variable according to your website requirements and return this variable.
// You can modify the $login_url variable conditionally too if you want.
return $login_url;
}
// add the filter
add_filter("login_url", "weplugins_modify_login_url_defaults", 10, 3);
Live Example 2
Another example of using the login_url filter to change the login URL:
function weplugins_custom_login_url($login_url, $redirect, $force_reauth) {
// This will append /custom-login/ to your main site URL as configured in general settings
return home_url('/custom-login/');
}
// add the filter
add_filter("login_url", "weplugins_custom_login_url", 10, 3);
Live Example 3
To remove a hook callback, use the example below:
remove_filter("login_url", "weplugins_modify_login_url_defaults", 10, 3);
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 customization, please contact us and we’d be happy to assist you.
