wppaste
WordPress

WP_Site_Query::set_found_sites()

Since
4.6.0
Source
wp-includes/class-wp-site-query.php:733
Populates found_sites and max_num_pages properties for the current query if the limit clause was used.

Compatibility

WordPress
since 4.6.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.

Performance profile

How much work a call to WP_Site_Query::set_found_sites() 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
5–21

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

Plugin surface
1 hook

Third-party callbacks on 'found_sites_query' 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()called directly
  • sqldatabase query->get_var()called directly

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always5–8none
always21apply_filters(), ->get_var()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 21 instructions, 5–21 executed per call, 2 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 · 1

One hook fires while WP_Site_Query::set_found_sites() runs, in this order:

  1. apply_filters( found_sites_query )filterline 745 (+12 into the body)

    Filters the query used to retrieve found site count.

Uses · 1

  • apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

Source code

View on Trac View on GitHub 

	private function set_found_sites() {		global $wpdb; 		if ( $this->query_vars['number'] && ! $this->query_vars['no_found_rows'] ) {			/**			 * Filters the query used to retrieve found site count.			 *			 * @since 4.6.0			 *			 * @param string        $found_sites_query SQL query. Default 'SELECT FOUND_ROWS()'.			 * @param WP_Site_Query $site_query        The `WP_Site_Query` instance.			 */			$found_sites_query = apply_filters( 'found_sites_query', 'SELECT FOUND_ROWS()', $this ); 			$this->found_sites = (int) $wpdb->get_var( $found_sites_query );		}	}

Changelog

Introduced in 4.6.0. Unchanged from 6.7.7 through 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.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-site-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.