How to use get_terms_orderby filter in WordPress

get_terms_orderby filter

Filters the ORDERBY clause of the terms query. To use get_terms_orderby 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 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_orderby_defaults which takes 3 parameters and we registered using add_filter. The first parameter get_terms_orderby is name of the hook, The second parameter modify_get_terms_orderby_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.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove get_terms_orderby filter.

Parameters

Below are the 3 parameters required to use this hook.

• $orderby: (string) ORDERBY clause of the terms query.
• $args: (array) An array of term query arguments.
• $taxonomies: (string[]) An array of taxonomy names.

Example 1: Basic Usage

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

    function weplugins_modify_get_terms_orderby_defaults($orderby, $args, $taxonomies) { 
        // Update the $orderby variable according to your website requirements and return this variable. 
        // You can modify the $orderby variable conditionally too if you want.
        return $orderby; 
    }
    // add the filter
    add_filter( "get_terms_orderby", "weplugins_modify_get_terms_orderby_defaults", 10, 3 );
    

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "get_terms_orderby", "weplugins_modify_get_terms_orderby_defaults", 10, 3 );
    

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

Example 3: Conditional ORDERBY Modification

Here is an example where the ORDERBY clause is modified based on specific conditions.

    function weplugins_conditional_orderby($orderby, $args, $taxonomies) {
        if (in_array('category', $taxonomies)) {
            $orderby = 'name ASC'; // Example condition
        }
        return $orderby;
    }
    add_filter("get_terms_orderby", "weplugins_conditional_orderby", 15, 3);
    

Contact Us

If you need any customization or having trouble using this hook, please contact us. We’d be happy to assist you.