How to use comment_post action in WordPress

comment_post action

Fires immediately after a comment is inserted into the database.

To use comment_post 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 execute_on_comment_post_event which takes 3 parameters and we registered using add_action. The first parameter comment_post is the name of the hook, The second parameter execute_on_comment_post_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_post action.

Parameters

Below are the 3 parameters required to use this hook.

• $comment_ID : (int) The comment ID.
• $comment_approved : (int|string) 1 if the comment is approved, 0 if not, ‘spam’ if spam.
• $commentdata : (array) Comment data.

Live Example 1

Below is an example of how you can use this hook to show a message when a comment is approved.

function weplugins_show_message_function( $comment_ID, $comment_approved ) {
	    if( 1 === $comment_approved ){
	        //function logic goes here
	    }
	}
	add_action( 'comment_post', 'weplugins_show_message_function', 10, 2 );

Live Example 2

Here is another example where you can execute custom functionality when a comment is posted.

	function weplugins_execute_on_comment_post_event($comment_ID, $comment_approved, $commentdata){
	   //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_post", "weplugins_execute_on_comment_post_event" , 10, 3);

Live Example 3

To remove a hook callback, use the example below.

remove_action( "comment_post", "weplugins_execute_on_comment_post_event", 10, 3 );

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 or need customization, please Contact Us and we’d be happy to assist you.