How to use comment_form_submit_field filter in WordPress

comment_form_submit_field filter

The submit field includes the submit button, hidden fields for the comment form, and any wrapper markup.

To use the comment_form_submit_field 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.

At WePlugins, we 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 example below, we have defined a function weplugins_modify_comment_form_submit_field_defaults which takes 2 parameters and we registered it using add_filter. The first parameter comment_form_submit_field is the name of the hook, the second parameter weplugins_modify_comment_form_submit_field_defaults 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_filter to remove the comment_form_submit_field filter.

Parameters

Below are the 2 parameters required to use this hook.

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

Live Example 1: Basic Usage

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

    function weplugins_modify_comment_form_submit_field_defaults($submit_field, $args) { 
        // Update the $submit_field variable according to your website requirements and return this variable.
        return $submit_field; 
    }
    // Add the filter
    add_filter("comment_form_submit_field", "weplugins_modify_comment_form_submit_field_defaults", 10, 2);
    

Live Example 2: Conditional Modification

Modify the submit field conditionally based on specific requirements.

    function weplugins_conditional_modify_comment_form_submit_field($submit_field, $args) { 
        if (is_user_logged_in()) {
            $submit_field = '<p>You are logged in. Submit your comment!</p>' . $submit_field;
        }
        return $submit_field; 
    }
    // Add the filter
    add_filter("comment_form_submit_field", "weplugins_conditional_modify_comment_form_submit_field", 10, 2);
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("comment_form_submit_field", "weplugins_modify_comment_form_submit_field_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 our WordPress Development Team and we’d be happy to assist you.