How to use get_terms filter in WordPress

get_terms filter

Filters the found terms.

To use get_terms 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_get_terms_defaults which takes 4 parameters and we registered using add_filter. The first parameter get_terms is the name of the hook, The second parameter modify_get_terms_defaults is the name of the function which needs to be called, 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 get_terms filter.

Parameters

Below are the 4 parameters required to use this hook.

• $terms : (array) Array of found terms.
• $taxonomies : (array|null) An array of taxonomies if known.
• $args : (array) An array of get_terms() arguments.
• $term_query : (WP_Term_Query) The WP_Term_Query object.

Example 1: Basic Modification

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

    function weplugins_modify_get_terms_defaults($terms, $taxonomies, $args, $term_query) { 
        // Update the $terms variable according to your website requirements and return this variable. 
        return $terms; 
    }
    // add the filter
    add_filter("get_terms", "weplugins_modify_get_terms_defaults", 10, 4);
    

Example 2: Conditional Modification

This example shows how you can conditionally modify the terms returned by the query.

    function weplugins_conditional_modify_get_terms($terms, $taxonomies, $args, $term_query) { 
        if(in_array('category', $taxonomies)) {
            // Perform some modifications
        }
        return $terms; 
    }
    add_filter("get_terms", "weplugins_conditional_modify_get_terms", 10, 4);
    

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("get_terms", "weplugins_modify_get_terms_defaults", 10, 4);
    

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

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.