How to use removable_query_args filter in WordPress

removable_query_args filter

Filters the list of query variable names to remove.

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

Parameters

Below the 1 parameter is required to use this hook.

• $removable_query_args : (string[]) An array of query variable names to remove from a URL.

Live Example

apply_filters( 'removable_query_args', string[] $removable_query_args )

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

Example 1: Basic Usage

This example demonstrates the basic usage of the removable_query_args filter.

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

Example 2: Conditional Modification

This example shows how to conditionally modify the query arguments to be removed.

        function weplugins_modify_removable_query_args_conditionally($removable_query_args) { 
            if (is_page('example-page')) {
                // Modify the query args only for 'example-page'
                $removable_query_args[] = 'extra_arg';
            }
            return $removable_query_args; 
        }
        // add the filter
        add_filter( "removable_query_args", "weplugins_modify_removable_query_args_conditionally", 10, 1 );
    

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

        remove_filter( "removable_query_args", "weplugins_modify_removable_query_args_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 need any customization, please Contact Us.