How to use comments_template_top_level_query_args filter in WordPress

comments_template_top_level_query_args filter

Top ↑

To use comments_template_top_level_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 Flipper Code, 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_comments_template_top_level_query_args_defaults which takes 1 parameters and we registered using add_filter. The first parameter comments_template_top_level_query_args is name of the hook, The second parameter modify_comments_template_top_level_query_args_defaults is name of the function which need 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.

Sometime, you have to remove a registered hook so you can use remove_filter to remove comments_template_top_level_query_args filter.

Parameters

Below the 1 parameter is required to use this hook.

• $top_level_args : (array) The top level query arguments for the comments template.
  ‘count’
  (bool) Whether to return a comment count.
  ‘orderby’
  (string|array) The field(s) to order by.
  ‘post_id’
  (int) The post ID.
  ‘status’
  (string|array) The comment status to limit results by.

Live Example

apply_filters( 'comments_template_top_level_query_args', array $top_level_args )

Below is an example how you can use this hook.

                        function modify_comments_template_top_level_query_args_defaults($top_level_args) { 
   
                            // Update the $top_level_args variable according to your website requirements and return this variable. You can modify the $top_level_args variable conditionally too if you want.

                            return $top_level_args; 
                        }
                        // add the filter
                        add_filter( "comments_template_top_level_query_args", "modify_comments_template_top_level_query_args_defaults", 10, 1 );

To remove a hook callback, use the example below.

remove_filter( "comments_template_top_level_query_args", "modify_comments_template_top_level_query_args_defaults", 10, 1 );

Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.