WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Site_Query::set_found_sites()

WP_Site_Query::set_found_sites()

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Populates found_sites and max_num_pages properties for the current query if the limit clause was used.

Source

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 );
	}
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘found_sites_query’, string $found_sites_query, WP_Site_Query $site_query )

Filters the query used to retrieve found site count.

UsesDescription
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

wpdb::get_var()wp-includes/class-wpdb.php

Retrieves one value from the database.

Used byDescription
WP_Site_Query::get_sites()wp-includes/class-wp-site-query.php

Retrieves a list of sites matching the query vars.

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.