wppaste
WordPress

WP_Query::set_found_posts( array $query_vars, string $limits )

Since
3.5.0
Source
wp-includes/class-wp-query.php:3684
Sets up the amount of found posts and the number of pages (if limit clause was used) for the current query.

Compatibility

WordPress
since 3.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$query_varsarray
Query variables.
$limitsstring
LIMIT clauses of the query.

Performance profile

How much work a call to WP_Query::set_found_posts() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Heavy

Reaches the database via ->get_var().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
6–50

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 67.

Plugin surface
2 hooks

Third-party callbacks on 'found_posts_query', 'found_posts' run inside this call, and their cost is not bounded by anything here.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksapply_filters_ref_array()called directly
  • sqldatabase query->get_var()called directly

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Query::set_found_posts() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always6–35none
!$query_vars39–41SELECT FOUND_ROWS()(), ->get_var()
!$query_vars41–44ceil()
!$query_vars && !empty($limits)48–50SELECT FOUND_ROWS()(), ->get_var(), ceil()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 67 instructions, 6–50 executed per call, 7 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 2

2 hooks fire while WP_Query::set_found_posts() runs, in this order:

  1. apply_filters( found_posts_query )filterline 3704 (+20 into the body)

    Filters the query to run for retrieving the found posts.

  2. apply_filters( found_posts )filterline 3727 (+43 into the body)

    Filters the number of found posts for the query.

Uses · 1

  • apply_filters_ref_array()Calls the callback functions that have been added to a filter hook, specifying arguments in an array.

Used by · 1

Source code

View on Trac View on GitHub 

	private function set_found_posts( $query_vars, $limits ) {		global $wpdb; 		/*		 * Bail if posts is an empty array. Continue if posts is an empty string,		 * null, or false to accommodate caching plugins that fill posts later.		 */		if ( $query_vars['no_found_rows'] || ( is_array( $this->posts ) && ! $this->posts ) ) {			return;		} 		if ( ! empty( $limits ) ) {			/**			 * Filters the query to run for retrieving the found posts.			 *			 * @since 2.1.0			 *			 * @param string   $found_posts_query The query to run to find the found posts.			 * @param WP_Query $query             The WP_Query instance (passed by reference).			 */			$found_posts_query = apply_filters_ref_array( 'found_posts_query', array( 'SELECT FOUND_ROWS()', &$this ) ); 			$this->found_posts = (int) $wpdb->get_var( $found_posts_query );		} else {			if ( is_array( $this->posts ) ) {				$this->found_posts = count( $this->posts );			} else {				if ( null === $this->posts ) {					$this->found_posts = 0;				} else {					$this->found_posts = 1;				}			}		} 		/**		 * Filters the number of found posts for the query.		 *		 * @since 2.1.0		 *		 * @param int      $found_posts The number of posts found.		 * @param WP_Query $query       The WP_Query instance (passed by reference).		 */		$this->found_posts = (int) apply_filters_ref_array( 'found_posts', array( $this->found_posts, &$this ) ); 		if ( ! empty( $limits ) ) {			$this->max_num_pages = (int) ceil( $this->found_posts / $query_vars['posts_per_page'] );		}	}

Changelog

Introduced in 3.5.0. 2 changes between 6.7.7 and 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.9.7
Parameter $query_vars added.verified against source
6.9.7
Parameter $q removed.verified against source
3.5.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.