found_posts WordPress Filter Hook

The found_posts hook is triggered when a query has been executed and the number of posts found is returned. This hook can be used to alter the query or perform some action based on the number of posts found.

apply_filters_ref_array( 'found_posts', int $found_posts, WP_Query $query ) #

Filters the number of found posts for the query.


Parameters

$found_posts

(int)The number of posts found.

$query

(WP_Query)The WP_Query instance (passed by reference).


Top ↑

More Information

This filter hook allows developers to adjust the number of posts that WordPress’s WP_Query class reports finding when it runs a query.

This hook is especially useful when developing custom pagination. For instance, if you are declaring a custom offset value in your queries, WordPress will NOT deduct the offset from the the $wp_query->found_posts parameter (for example, if you have 45 usable posts after an offset of 10, WordPress will ignore the offset and still give found_posts a value of 55).

Make sure you haven’t passed no_found_rows in query arguments, Otherwise you will receive a 0 value in return.


Top ↑

Source

File: wp-includes/class-wp-query.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
2.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More