How to use get_default_comment_status filter in WordPress

get_default_comment_status filter

Filters the default comment status for the given post type.

To use the get_default_comment_status filter, first you have to register it using add_filter. You can write this code into the 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 weplugins_modify_get_default_comment_status_defaults which takes 3 parameters and we registered using add_filter. The first parameter get_default_comment_status is the name of the hook, The second parameter weplugins_modify_get_default_comment_status_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 get_default_comment_status filter.

Parameters

Below are the 3 parameters required to use this hook.

• $status: (string) Default status for the given post type, either ‘open’ or ‘closed’.
• $post_type: (string) Post type. Default is post.
• $comment_type: (string) Type of comment. Default is comment.

Live Example 1: Basic Usage

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

    function weplugins_modify_get_default_comment_status_defaults($status, $post_type, $comment_type) {
        // Update the $status variable according to your website requirements and return this variable. 
        return $status; 
    }
    // Add the filter
    add_filter( "get_default_comment_status", "weplugins_modify_get_default_comment_status_defaults", 10, 3 );
    

Live Example 2: Conditional Status

In this example, comments are closed by default for ‘page’ post types.

    function weplugins_modify_get_default_comment_status_defaults($status, $post_type, $comment_type) {
        if ($post_type == 'page') {
            $status = 'closed';
        }
        return $status;
    }
    // Add the filter
    add_filter( "get_default_comment_status", "weplugins_modify_get_default_comment_status_defaults", 10, 3 );
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

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