This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.
auth_redirect_scheme filter
Filters the authentication redirect scheme.
To use the auth_redirect_scheme 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 weplugins_modify_auth_redirect_scheme_defaults which takes 1 parameter and we registered using add_filter. The first parameter auth_redirect_scheme is the name of the hook, the second parameter weplugins_modify_auth_redirect_scheme_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 auth_redirect_scheme filter.
Parameters
- $scheme : (string) Authentication redirect scheme. Default empty.
Below the 1 parameter is required to use this hook.
Live Example
apply_filters( ‘auth_redirect_scheme’, string $scheme )
Below is an example of how you can use this hook.
Example 1: Modify the Authentication Redirect Scheme
This example shows how to modify the authentication redirect scheme.
function weplugins_modify_auth_redirect_scheme_defaults($scheme) { // Update the $scheme variable according to your website requirements and return this variable. // You can modify the $scheme variable conditionally too if you want. return $scheme; } // Add the filter add_filter( "auth_redirect_scheme", "weplugins_modify_auth_redirect_scheme_defaults", 10, 1 );
Example 2: Remove the Hook Callback
To remove a hook callback, use the example below.
remove_filter( "auth_redirect_scheme", "weplugins_modify_auth_redirect_scheme_defaults", 10, 1 );
Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.
Example 3: Conditional Modification
Here’s how you can conditionally modify the authentication redirect scheme.
function weplugins_modify_auth_redirect_scheme_conditionally($scheme) { if ( is_admin() ) { $scheme = 'admin'; } else { $scheme = 'public'; } return $scheme; } // Add the filter add_filter( "auth_redirect_scheme", "weplugins_modify_auth_redirect_scheme_conditionally", 10, 1 );
If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.
Explore the latest in WordPress
Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.