How to use add_term_relationship action in WordPress

add_term_relationship action

Fires immediately before an object-term relationship is added.

To use add_term_relationship action, first, you have to register it using add_action. 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_execute_on_add_term_relationship_event which takes 3 parameters and we registered using add_action. The first parameter add_term_relationship is the name of the hook, the second parameter weplugins_execute_on_add_term_relationship_event 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_action to remove add_term_relationship action.

Parameters

Below are the 3 parameters required to use this hook:

• $object_id: (int) Object ID.
• $tt_id: (int) Term taxonomy ID.
• $taxonomy: (string) Taxonomy slug.

Live Example 1

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

    function weplugins_execute_on_add_term_relationship_event($object_id, $tt_id, $taxonomy){
       // You can write code here to be executed when this action occurs in WordPress.
    }
    // add the action
    add_action("add_term_relationship", "weplugins_execute_on_add_term_relationship_event", 10, 3);
    

Live Example 2

To remove a hook callback, use the example below:

    remove_action("add_term_relationship", "weplugins_execute_on_add_term_relationship_event", 10, 3);
    

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

Live Example 3

Another way to handle this action is by adding additional custom functionality:

    function weplugins_custom_function_on_add_term_relationship($object_id, $tt_id, $taxonomy){
        // Custom code to execute on add_term_relationship action
    }
    add_action("add_term_relationship", "weplugins_custom_function_on_add_term_relationship", 15, 3);
    

Contact Us

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