How to use admin_referrer_policy filter in WordPress

admin_referrer_policy filter

Filters the admin referrer policy header value.

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

Parameters

Below the 1 parameter is required to use this hook.

• $policy: (string) The admin referrer policy header value. Default ‘strict-origin-when-cross-origin’.

Live Example

apply_filters( 'admin_referrer_policy', string $policy )

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

Example 1: Basic Usage

In this example, we simply modify the admin referrer policy to match our site requirements.

        function weplugins_modify_admin_referrer_policy_defaults($policy) { 
            // Update the $policy variable according to your website requirements and return this variable.
            return $policy; 
        }
        // add the filter
        add_filter( "admin_referrer_policy", "weplugins_modify_admin_referrer_policy_defaults", 10, 1 );
    

Example 2: Conditional Modification

This example shows how you can modify the policy conditionally based on certain criteria.

        function weplugins_modify_admin_referrer_policy_defaults($policy) { 
            if (is_admin()) {
                // Modify the policy for admin pages
                $policy = 'unsafe-url';
            }
            return $policy; 
        }
        // add the filter
        add_filter( "admin_referrer_policy", "weplugins_modify_admin_referrer_policy_defaults", 10, 1 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

        remove_filter( "admin_referrer_policy", "weplugins_modify_admin_referrer_policy_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.