How to use found_comments_query filter in WordPress

found_comments_query filter

Filters the query used to retrieve the found comment count.

To use the found_comments_query 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_found_comments_query_defaults which takes 2 parameters and we registered it using add_filter. The first parameter found_comments_query is the name of the hook, the second parameter weplugins_modify_found_comments_query_defaults is the name of the function that 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 to the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove the found_comments_query filter.

Parameters

Below are the 2 parameters required to use this hook.

• $found_comments_query : (string) SQL query. Default ‘SELECT FOUND_ROWS()’.
• $comment_query : (WP_Comment_Query) The WP_Comment_Query instance.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("found_comments_query", "weplugins_modify_found_comments_query_defaults", 10, 2);
    

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

Live Example 3

Another example showing conditional modification of the $found_comments_query variable.

    function weplugins_custom_found_comments_query($found_comments_query, $comment_query) {
        if ($comment_query->query_vars['status'] == 'approved') {
            $found_comments_query = "SELECT COUNT(*) FROM {$comment_query->query_vars['comment_table']} WHERE comment_approved = 1";
        }
        return $found_comments_query;
    }
    add_filter("found_comments_query", "weplugins_custom_found_comments_query", 10, 2);
    

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.