How to use redirect_canonical filter in WordPress

redirect_canonical filter

Returning false to this filter will cancel the redirect.

To use redirect_canonical 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 Flipper Code, 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_redirect_canonical_defaults which takes 2 parameters and we registered using add_filter. The first parameter redirect_canonical is name of the hook, The second parameter modify_redirect_canonical_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove redirect_canonical filter.

Parameters

Below are the 2 parameters are required to use this hook.

• $redirect_url : (string) The redirect URL.
• $requested_url : (string) The requested URL.

Live Example

apply_filters( 'redirect_canonical', string $redirect_url, string $requested_url )

Below is an example how you can use this hook.

                        function modify_redirect_canonical_defaults($redirect_url, $requested_url) { 
   
                            // Update the $redirect_url variable according to your website requirements and return this variable. You can modify the $redirect_url variable conditionally too if you want.

                            return $redirect_url; 
                        }
                        // add the filter
                        add_filter( "redirect_canonical", "modify_redirect_canonical_defaults", 10, 2 );

To remove a hook callback, use the example below.

remove_filter( "redirect_canonical", "modify_redirect_canonical_defaults", 10, 2 );

Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.