How to use comment_form_submit_button filter in WordPress

comment_form_submit_button filter

Filters the submit button for the comment form to display.

To use comment_form_submit_button filter, first you have to register it using add_filter. 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 modify_comment_form_submit_button_defaults which takes 2 parameters and we registered using add_filter. The first parameter comment_form_submit_button is name of the hook, the second parameter modify_comment_form_submit_button_defaults is name of the function which needs to be called, third parameter is the priority of calling the hook if 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_filter to remove comment_form_submit_button filter.

Parameters

Below are the 2 parameters required to use this hook.

• $submit_button : (string) HTML markup for the submit button.
• $args : (array) Arguments passed to comment_form().

Live Example 1: Wrapping Submit Button

This example wraps the submit button in a div with a class of “form-group”.

    // define the comment_form_submit_button callback
    function weplugins_filter_comment_form_submit_button( $submit_button, $args ) {
        // make filter magic happen here...
        $submit_before = '<div class="form-group">';
        $submit_after = '</div>';
        return $submit_before . $submit_button . $submit_after;
    }
    // add the filter
    add_filter( 'comment_form_submit_button', 'weplugins_filter_comment_form_submit_button', 10, 2 );
    

Live Example 2: Modifying Submit Button

Below is an example of how you can modify the submit button according to your website requirements:

    function weplugins_modify_comment_form_submit_button_defaults( $submit_button, $args ) {
        // Update the $submit_button variable according to your website requirements and return this variable.
        // You can modify the $submit_button variable conditionally too if you want.
        return $submit_button;
    }
    // add the filter
    add_filter( "comment_form_submit_button", "weplugins_modify_comment_form_submit_button_defaults", 10, 2 );
    

Live Example 3: Removing Submit Button Filter

To remove a hook callback, use the example below:

    remove_filter( "comment_form_submit_button", "weplugins_modify_comment_form_submit_button_defaults", 10, 2 );
    

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 us and we’d be happy to assist you.