How to use redirect_user_admin_request filter in WordPress

redirect_user_admin_request filter

Filters whether to redirect the request to the User Admin in Multisite.

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

Parameters

Below the 1 parameter is required to use this hook.

• $redirect_user_admin_request : (bool) Whether the request should be redirected.

Live Examples

Example 1: Basic Usage

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

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

Example 2: Conditional Redirection

Here’s how you can conditionally modify the redirection.

    function weplugins_modify_redirect_user_admin_request_conditionally($redirect_user_admin_request) { 
        if (is_user_logged_in()) {
            $redirect_user_admin_request = true;
        } else {
            $redirect_user_admin_request = false;
        }
        return $redirect_user_admin_request; 
    }
    // add the filter
    add_filter("redirect_user_admin_request", "weplugins_modify_redirect_user_admin_request_conditionally", 10, 1);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("redirect_user_admin_request", "weplugins_modify_redirect_user_admin_request_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.