How to use get_terms_args filter in WordPress

get_terms_args filter

Filters the terms query arguments.

To use get_terms_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.

At WePlugins, we 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_args_defaults which takes 2 parameters and we registered using add_filter. The first parameter get_terms_args is the name of the hook, the second parameter modify_get_terms_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 get_terms_args filter.

Parameters

Below are the 2 parameters required to use this hook.

• $args : (array) An array of get_terms() arguments.
• $taxonomies : (string[]) An array of taxonomy names.

Live Example 1: Ordering Categories

In this example, we are ordering categories by their description in ascending order.

/**
 * Order categories
 * 
 */
function weplugins_custom_sort_get_terms_args( $args, $taxonomies ) 
{
    $args['orderby'] = 'description';
    $args['order']   = 'ASC';
     return $args;
}
add_filter( 'get_terms_args', 'weplugins_custom_sort_get_terms_args', 10, 2 );

Live Example 2: Modifying Default Arguments

Below is an example of how you can use this hook to modify the default arguments.

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

    return $args; 
}
// add the filter
add_filter( "get_terms_args", "weplugins_modify_get_terms_args_defaults", 10, 2 );

Live Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

remove_filter( "get_terms_args", "weplugins_modify_get_terms_args_defaults", 10, 2 );

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 or need customization, please Contact Us and we’d be happy to assist you.