How to use comment_closed action in WordPress

comment_closed action

Fires when a comment is attempted on a post that has comments closed.

To use the comment_closed 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 examples, we have defined a function weplugins_execute_on_comment_closed_event which takes 1 parameter and we registered using add_action. The first parameter comment_closed is the name of the hook, the second parameter weplugins_execute_on_comment_closed_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 comment_closed 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_closed_event($comment_post_ID){
        // 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("comment_closed", "weplugins_execute_on_comment_closed_event", 10, 1);
    

Live Example 2: Logging Closed Comments

This example logs a message when a comment is attempted on a closed post.

    function weplugins_log_comment_closed($comment_post_ID) {
        error_log("Comment attempt on post ID: $comment_post_ID, but comments are closed.");
    }
    // add the action
    add_action("comment_closed", "weplugins_log_comment_closed", 10, 1);
    

Live Example 3: Displaying a Custom Message

This example displays a custom message to users when comments are closed on a post.

    function weplugins_custom_message_on_comment_closed($comment_post_ID) {
        echo "<p>Sorry, comments are closed for this post.</p>";
    }
    // add the action
    add_action("comment_closed", "weplugins_custom_message_on_comment_closed", 10, 1);
    

Removing a Hook

To remove a hook callback, use the example below.

    remove_action("comment_closed", "weplugins_execute_on_comment_closed_event", 10, 1);
    

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

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.