How to use get_page_of_comment_query_args filter in WordPress

get_page_of_comment_query_args filter

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

Parameters

Below the 1 parameter is required to use this hook.

• $comment_args: (array) Array of WP_Comment_Query arguments.
  • type (string): Limit paginated comments to those matching a given type. Accepts ‘comment’, ‘trackback’, ‘pingback’, ‘pings’ (trackbacks and pingbacks), or ‘all’. Default ‘all’.
  • post_id (int): ID of the post.
  • fields (string): Comment fields to return.
  • count (bool): Whether to return a comment count (true) or array of comment objects (false).
  • status (string): Comment status.
  • parent (int): Parent ID of comment to retrieve children of.
  • date_query (array): Date query clauses to limit comments by. See WP_Date_Query.
  • include_unapproved (array): Array of IDs or email addresses whose unapproved comments will be included in paginated comments.

Live Examples

Example 1: Basic Usage

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

    function weplugins_modify_get_page_of_comment_query_args_defaults($comment_args) { 
        // Update the $comment_args variable according to your website requirements and return this variable.
        return $comment_args; 
    }
    // add the filter
    add_filter("get_page_of_comment_query_args", "weplugins_modify_get_page_of_comment_query_args_defaults", 10, 1);
    

Example 2: Conditional Modification

Here is how you can conditionally modify the $comment_args based on certain conditions.

    function weplugins_modify_get_page_of_comment_query_args_defaults($comment_args) { 
        if (is_page('contact')) {
            $comment_args['type'] = 'comment';
        }
        return $comment_args; 
    }
    // add the filter
    add_filter("get_page_of_comment_query_args", "weplugins_modify_get_page_of_comment_query_args_defaults", 10, 1);
    

Example 3: Removing the Filter

To remove a hook callback, use the example below.

    remove_filter("get_page_of_comment_query_args", "weplugins_modify_get_page_of_comment_query_args_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’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.