How to use comment_form_defaults filter in WordPress

comment_form_defaults filter

Use comment_form_default_fields to filter the comment fields.

To use comment_form_defaults 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_defaults_defaults which takes 1 parameter and we registered using add_filter. The first parameter comment_form_defaults is the name of the hook, the second parameter modify_comment_form_defaults_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 comment_form_defaults filter.

Parameters

Below the 1 parameter is required to use this hook.

• $defaults : (array) The default comment form arguments.

Live Example

Example 1: Setting Default Comment Form Title

In this example, we modify the default title of the comment form.

    function weplugins_set_comment_form_defaults( $defaults ) {
        //Here you are able to change the $defaults[]
        //For example: 
        $defaults['title_reply'] = __( 'Add a Comment' );
        return $defaults;
    }
    add_filter( 'comment_form_defaults', 'weplugins_set_comment_form_defaults' );
    

Example 2: Modifying Comment Form Defaults

Below is an example of how you can use this hook to modify the comment form defaults.

    function weplugins_modify_comment_form_defaults_defaults($defaults) { 
        // Update the $defaults variable according to your website requirements and return this variable. You can modify the $defaults variable conditionally too if you want.
        return $defaults; 
    }
    // add the filter
    add_filter( "comment_form_defaults", "weplugins_modify_comment_form_defaults_defaults", 10, 1 );
    

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "comment_form_defaults", "weplugins_modify_comment_form_defaults_defaults", 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 need any customization or are having trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.