How to use edit_comment action in WordPress

edit_comment action

The edit_comment hook also fires immediately before comment status transition hooks are fired.

To use the edit_comment action, first you have to register it using add_action. You can write this code into the 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_edit_comment_event which takes 2 parameters and we registered using add_action. The first parameter edit_comment is the name of the hook, the second parameter weplugins_execute_on_edit_comment_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 the edit_comment action.

Parameters

Below are the 2 parameters required to use this hook.

• $comment_ID : (int) The comment ID.
• $data : (array) Comment data.

Live Example 1

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

    function weplugins_execute_on_edit_comment_event($comment_ID, $data){
       // 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( "edit_comment", "weplugins_execute_on_edit_comment_event", 10, 2 );
    

Live Example 2

To remove a hook callback, use the example below.

    remove_action( "edit_comment", "weplugins_execute_on_edit_comment_event", 10, 2 );
    

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

Live Example 3

Here’s another example of modifying the comment data before it gets saved.

    function weplugins_modify_comment_data($comment_ID, $data){
        // Modify the comment data
        $data['comment_content'] .= ' - Edited by WePlugins';
        // Update the comment
        wp_update_comment(array('comment_ID' => $comment_ID, 'comment_content' => $data['comment_content']));
    }
    // Add the action
    add_action( "edit_comment", "weplugins_modify_comment_data", 10, 2 );
    

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