How to use category_link filter in WordPress

category_link filter

Filters the category link.

To use the category_link 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_category_link_defaults which takes 2 parameters and we registered using add_filter. The first parameter category_link is the name of the hook, the second parameter weplugins_modify_category_link_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 category_link filter.

Parameters

Below are the 2 parameters required to use this hook.

• $termlink: (string) Category link URL.
• $term_id: (int) Term ID.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("category_link", "weplugins_modify_category_link_defaults", 10, 2);
    

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

Live Example 3

Adding a custom parameter to the category link dynamically based on the term ID.

    function weplugins_custom_category_link($termlink, $term_id) {
        if($term_id == 123) {
            $termlink .= '?custom_param=true';
        }
        return $termlink;
    }
    add_filter("category_link", "weplugins_custom_category_link", 10, 2);
    

Contact Us

If you need any customization or assistance using this hook, feel free to contact us.