How to use edited_terms action in WordPress

edited_terms action

Fires immediately after a term is updated in the database, but before its term-taxonomy relationship is updated.

To use edited_terms 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_edited_terms_event which takes 2 parameters and we registered using add_action. The first parameter edited_terms is name of the hook, The second parameter weplugins_execute_on_edited_terms_event 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.

Sometime, you have to remove a registered hook so you can use remove_action to remove edited_terms action.

Parameters

Below are the 2 parameters required to use this hook.

• $term_id : (int) Term ID.
• $taxonomy : (string) Taxonomy slug.

Live Examples

Example 1: Basic Usage

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

    function weplugins_execute_on_edited_terms_event($term_id, $taxonomy){
        // You can write code here to be executed when this action occurs in WordPress.
        // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // add the action
    add_action( "edited_terms", "weplugins_execute_on_edited_terms_event" , 10, 2);
    

Example 2: Removing the Hook

To remove a hook callback, use the example below.

    remove_action( "edited_terms", "weplugins_execute_on_edited_terms_event", 10, 2 );
    

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

Example 3: Custom Functionality

In this example, we add custom functionality that logs the term update to a custom log file.

    function weplugins_log_edited_terms($term_id, $taxonomy){
        $message = "Term ID: $term_id was updated in the $taxonomy taxonomy.";
        error_log($message, 3, WP_CONTENT_DIR . '/edited_terms.log');
    }
    add_action( "edited_terms", "weplugins_log_edited_terms" , 10, 2);
    

Contact Us

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