How to use comment_form action in WordPress

comment_form action

Fires at the bottom of the comment form, inside the closing form tag.

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

Parameters

Below the 1 parameter is required to use this hook.

• $post_id : (int) The post ID.

Live Example

Example 1: Displaying an Extra Text Area for More Comments

This example shows how to add an extra text area for more comments in the comment form.

    /**
     * Displays an extra text area for more comments.
     *
     * @param int $post_id The ID of the post where the comment form was rendered.
     */
    function weplugins_more_comments( $post_id ) {
        echo '<p class="comment-form-more-comments"><label for="more-comments">' . __( 'More Comments', 'your-theme-text-domain' ) . '</label> <textarea id="more-comments" name="more-comments" cols="45" rows="8" aria-required="true"></textarea></p>';
    }
    add_action( 'comment_form', 'weplugins_more_comments' );
    

Example 2: Adding Custom Functionality When the Comment Form is Loaded

Below is an example of how you can use this hook to add custom functionalities when the comment form is loaded.

    function weplugins_execute_on_comment_form_event($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_form", "weplugins_execute_on_comment_form_event" , 10, 1);
    

Example 3: Removing an Existing Hook Callback

To remove a hook callback, use the example below.

    remove_action( "comment_form", "weplugins_execute_on_comment_form_event", 10, 1 );
    

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