How to use comment_on_trash action in WordPress

comment_on_trash action

Fires when a comment is attempted on a trashed post.

To use comment_on_trash 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_comment_on_trash_event which takes 1 parameter and we registered using add_action. The first parameter comment_on_trash is the name of the hook, the second parameter weplugins_execute_on_comment_on_trash_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 comment_on_trash action.

Parameters

Below the 1 parameter is required to use this hook.

• $comment_post_ID : (int) Post ID.

Live Example 1: Basic Usage

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

    function weplugins_execute_on_comment_on_trash_event($comment_post_ID){
        // Code 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( "comment_on_trash", "weplugins_execute_on_comment_on_trash_event" , 10, 1);
    

Live Example 2: Logging the Event

Here’s how to log the event whenever a comment is attempted on a trashed post.

    function weplugins_log_comment_on_trash($comment_post_ID){
        error_log("A comment was attempted on a trashed post with ID: " . $comment_post_ID);
    }
    // Add the action
    add_action( "comment_on_trash", "weplugins_log_comment_on_trash" , 10, 1);
    

Live Example 3: Custom Notification

This example sends a custom notification email when the action occurs.

    function weplugins_notify_comment_on_trash($comment_post_ID){
        $admin_email = get_option('admin_email');
        wp_mail($admin_email, "Comment Attempted on Trashed Post", "A comment was attempted on a trashed post with ID: " . $comment_post_ID);
    }
    // Add the action
    add_action( "comment_on_trash", "weplugins_notify_comment_on_trash" , 10, 1);
    

To remove a hook callback, use the example below.

remove_action( "comment_on_trash", "weplugins_execute_on_comment_on_trash_event", 10, 1 );

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

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