How to use allowed_redirect_hosts filter in WordPress

allowed_redirect_hosts filter

Filters the list of allowed hosts to redirect to.

To use the allowed_redirect_hosts filter, you first 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 modify_allowed_redirect_hosts_defaults which takes two parameters and we registered using add_filter. The first parameter allowed_redirect_hosts is the name of the hook, the second parameter modify_allowed_redirect_hosts_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 the allowed_redirect_hosts filter.

Parameters

Below are the 2 parameters required to use this hook:

• $hosts: (string[]) An array of allowed host names.
• $host: (string) The host name of the redirect destination; empty string if not set.

Live Example 1

This example shows how to add custom hosts to the allowed redirect hosts list:

        function weplugins_my_allowed_redirect_hosts( $hosts ) {
            $my_hosts = array(
                'blog.example.com',
                'codex.example.com',
            );
            return array_merge( $hosts, $my_hosts );
        }
        add_filter( 'allowed_redirect_hosts', 'weplugins_my_allowed_redirect_hosts' );
        

Live Example 2

Below is an example of how you can use this hook to modify allowed redirect hosts conditionally:

        function weplugins_modify_allowed_redirect_hosts_defaults($hosts, $host) { 
            // Update the $hosts variable according to your website requirements and return this variable.
            // You can modify the $hosts variable conditionally too if you want.
            return $hosts; 
        }
        // Add the filter
        add_filter( "allowed_redirect_hosts", "weplugins_modify_allowed_redirect_hosts_defaults", 10, 2 );
        

Live Example 3

To remove a hook callback, use the example below:

        remove_filter( "allowed_redirect_hosts", "weplugins_modify_allowed_redirect_hosts_defaults", 10, 2 );
        

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.