How to use get_object_terms filter in WordPress

get_object_terms filter

Filters the terms for a given object or objects.

To use get_object_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 weplugins_modify_get_object_terms_defaults which takes 4 parameters and we registered using add_filter. The first parameter get_object_terms is the name of the hook, The second parameter weplugins_modify_get_object_terms_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_object_terms filter.

Parameters

Below are the 4 parameters required to use this hook:

• $terms : (WP_Term[]) Array of terms for the given object or objects.
• $object_ids : (int[]) Array of object IDs for which terms were retrieved.
• $taxonomies : (string[]) Array of taxonomy names from which terms were retrieved.
• $args : (array) Array of arguments for retrieving terms for the given object(s). See wp_get_object_terms() for details.

Live Example

apply_filters( 'get_object_terms', WP_Term[] $terms, int[] $object_ids, string[] $taxonomies, array $args )

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

Example 1: Modify Terms

This example demonstrates how to modify the terms retrieved for an object.

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

Example 2: Remove Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "get_object_terms", "weplugins_modify_get_object_terms_defaults", 10, 4 );
    

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

Example 3: Conditional Term Modification

This example shows how to conditionally modify terms based on specific criteria.

    function weplugins_modify_get_object_terms_conditionally($terms, $object_ids, $taxonomies, $args) { 
        if (in_array('custom_taxonomy', $taxonomies)) {
            // Modify $terms for the 'custom_taxonomy'
        }
        return $terms; 
    }
    // add the filter
    add_filter( "get_object_terms", "weplugins_modify_get_object_terms_conditionally", 10, 4 );
    

Contact Us

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