How to use found_posts filter in WordPress

found_posts filter

Filters the number of found posts for the query.

To use the found_posts 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 weplugins_modify_found_posts_defaults which takes 2 parameters and we registered using add_filter. The first parameter found_posts is the name of the hook, The second parameter weplugins_modify_found_posts_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 found_posts filter.

Parameters

Below are the 2 parameters required to use this hook.

• $found_posts : (int) The number of posts found.
• $query : (WP_Query) The WP_Query instance (passed by reference).

Live Example

Example 1: Modifying the Number of Found Posts

Below is an example of how you can use this hook to modify the number of found posts.

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

Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter("found_posts", "weplugins_modify_found_posts_defaults", 10, 2);
    

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

Example 3: Conditional Logic for Found Posts

Here’s how you can conditionally modify the number of found posts based on certain criteria.

    function weplugins_modify_found_posts_conditionally($found_posts, $query) { 
        if ($query->is_main_query() && !is_admin()) {
            // Custom logic to modify $found_posts
            $found_posts = 10; // Example: Setting found posts to 10
        }
        return $found_posts; 
    }
    // add the filter
    add_filter("found_posts", "weplugins_modify_found_posts_conditionally", 10, 2);
    

Contact Us

If you’re having any trouble using this hook or need customization, please Contact Us and we’d be happy to assist you.