* Site API: WP_Site_Query class
* Core class used for querying sites.
* @see WP_Site_Query::__construct() for accepted arguments.
#[AllowDynamicProperties]
* SQL for database query.
protected $sql_clauses = array(
* Metadata query container.
public $meta_query = false;
* Metadata query clauses.
protected $meta_query_clauses;
* @var WP_Date_Query A date query instance.
public $date_query = false;
* Query vars set by the user.
* Default values for query vars.
public $query_var_defaults;
* List of sites located by the query.
* The amount of found sites for the current query.
public $max_num_pages = 0;
* Sets up the site query, based on the query vars passed.
* @since 4.8.0 Introduced the 'lang_id', 'lang__in', and 'lang__not_in' parameters.
* @since 5.1.0 Introduced the 'update_site_meta_cache', 'meta_query', 'meta_key',
* 'meta_compare_key', 'meta_value', 'meta_type', and 'meta_compare' parameters.
* @since 5.3.0 Introduced the 'meta_type_key' parameter.
* @param string|array $query {
* Optional. Array or query string of site query parameters. Default empty.
* @type int[] $site__in Array of site IDs to include. Default empty.
* @type int[] $site__not_in Array of site IDs to exclude. Default empty.
* @type bool $count Whether to return a site count (true) or array of site objects.
* @type array $date_query Date query clauses to limit sites by. See WP_Date_Query.
* @type string $fields Site fields to return. Accepts 'ids' (returns an array of site IDs)
* or empty (returns an array of complete site objects). Default empty.
* @type int $ID A site ID to only return that site. Default empty.
* @type int $number Maximum number of sites to retrieve. Default 100.
* @type int $offset Number of sites to offset the query. Used to build LIMIT clause.
* @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true.
* @type string|array $orderby Site status or array of statuses. Accepts:
* - false, an empty array, or 'none' to disable `ORDER BY` clause.
* @type string $order How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'.
* @type int $network_id Limit results to those affiliated with a given network ID. If 0,
* include all networks. Default 0.
* @type int[] $network__in Array of network IDs to include affiliated sites for. Default empty.
* @type int[] $network__not_in Array of network IDs to exclude affiliated sites for. Default empty.
* @type string $domain Limit results to those affiliated with a given domain. Default empty.
* @type string[] $domain__in Array of domains to include affiliated sites for. Default empty.
* @type string[] $domain__not_in Array of domains to exclude affiliated sites for. Default empty.
* @type string $path Limit results to those affiliated with a given path. Default empty.
* @type string[] $path__in Array of paths to include affiliated sites for. Default empty.
* @type string[] $path__not_in Array of paths to exclude affiliated sites for. Default empty.
* @type int $public Limit results to public sites. Accepts 1 or 0. Default empty.
* @type int $archived Limit results to archived sites. Accepts 1 or 0. Default empty.
* @type int $mature Limit results to mature sites. Accepts 1 or 0. Default empty.
* @type int $spam Limit results to spam sites. Accepts 1 or 0. Default empty.
* @type int $deleted Limit results to deleted sites. Accepts 1 or 0. Default empty.
* @type int $lang_id Limit results to a language ID. Default empty.
* @type string[] $lang__in Array of language IDs to include affiliated sites for. Default empty.
* @type string[] $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty.
* @type string $search Search term(s) to retrieve matching sites for. Default empty.
* @type string[] $search_columns Array of column names to be searched. Accepts 'domain' and 'path'.
* @type bool $update_site_cache Whether to prime the cache for found sites. Default true.
* @type bool $update_site_meta_cache Whether to prime the metadata cache for found sites. Default true.
* @type string|string[] $meta_key Meta key or keys to filter by.
* @type string|string[] $meta_value Meta value or values to filter by.
* @type string $meta_compare MySQL operator used for comparing the meta value.
* See WP_Meta_Query::__construct() for accepted values and default value.
* @type string $meta_compare_key MySQL operator used for comparing the meta key.
* See WP_Meta_Query::__construct() for accepted values and default value.
* @type string $meta_type MySQL data type that the meta_value column will be CAST to for comparisons.
* See WP_Meta_Query::__construct() for accepted values and default value.
* @type string $meta_type_key MySQL data type that the meta_key column will be CAST to for comparisons.
* See WP_Meta_Query::__construct() for accepted values and default value.
* @type array $meta_query An associative array of WP_Meta_Query arguments.
* See WP_Meta_Query::__construct() for accepted values.
public function __construct( $query = '' ) {
$this->query_var_defaults = array(
'search_columns' => array(),
'date_query' => null, // See WP_Date_Query.
'update_site_cache' => true,
'update_site_meta_cache' => true,
if ( ! empty( $query ) ) {
* Parses arguments passed to the site query with default query parameters.
* @see WP_Site_Query::__construct()
* @param string|array $query Array or string of WP_Site_Query arguments. See WP_Site_Query::__construct().
public function parse_query( $query = '' ) {
$query = $this->query_vars;
$this->query_vars = wp_parse_args( $query, $this->query_var_defaults );
* Fires after the site query vars have been parsed.
* @param WP_Site_Query $query The WP_Site_Query instance (passed by reference).
do_action_ref_array( 'parse_site_query', array( &$this ) );
* Sets up the WordPress query for retrieving sites.
* @param string|array $query Array or URL query string of parameters.
* @return array|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids',
* or the number of sites when 'count' is passed as a query var.
public function query( $query ) {
$this->query_vars = wp_parse_args( $query );
return $this->get_sites();
* Retrieves a list of sites matching the query vars.
* @global wpdb $wpdb WordPress database abstraction object.
* @return array|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids',
* or the number of sites when 'count' is passed as a query var.
public function get_sites() {
$this->meta_query = new WP_Meta_Query();
$this->meta_query->parse_query_vars( $this->query_vars );
* Fires before sites are retrieved.
* @param WP_Site_Query $query Current instance of WP_Site_Query (passed by reference).
do_action_ref_array( 'pre_get_sites', array( &$this ) );
// Reparse query vars, in case they were modified in a 'pre_get_sites' callback.
$this->meta_query->parse_query_vars( $this->query_vars );
if ( ! empty( $this->meta_query->queries ) ) {
$this->meta_query_clauses = $this->meta_query->get_sql( 'blog', $wpdb->blogs, 'blog_id', $this );
* Filters the site data before the get_sites query takes place.
* Return a non-null value to bypass WordPress' default site queries.
* The expected return type from this filter depends on the value passed
* in the request query vars:
* - When `$this->query_vars['count']` is set, the filter should return
* the site count as an integer.
* - When `'ids' === $this->query_vars['fields']`, the filter should return
* - Otherwise the filter should return an array of WP_Site objects.
* Note that if the filter returns an array of site data, it will be assigned
* to the `sites` property of the current WP_Site_Query instance.
* Filtering functions that require pagination information are encouraged to set
* the `found_sites` and `max_num_pages` properties of the WP_Site_Query object,
* passed to the filter by reference. If WP_Site_Query does not perform a database
* query, it will not have enough information to generate these values itself.
* @since 5.6.0 The returned array of site data is assigned to the `sites` property
* of the current WP_Site_Query instance.
* @param array|int|null $site_data Return an array of site data to short-circuit WP's site query,
* the site count as an integer if `$this->query_vars['count']` is set,
* or null to run the normal queries.
* @param WP_Site_Query $query The WP_Site_Query instance, passed by reference.
$site_data = apply_filters_ref_array( 'sites_pre_query', array( $site_data, &$this ) );
if ( null !== $site_data ) {
if ( is_array( $site_data ) && ! $this->query_vars['count'] ) {
$this->sites = $site_data;
// $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
$_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );
// Ignore the $fields, $update_site_cache, $update_site_meta_cache argument as the queried result will be the same regardless.
unset( $_args['fields'], $_args['update_site_cache'], $_args['update_site_meta_cache'] );
$key = md5( serialize( $_args ) );
$last_changed = wp_cache_get_last_changed( 'sites' );
$cache_key = "get_sites:$key:$last_changed";
$cache_value = wp_cache_get( $cache_key, 'site-queries' );
if ( false === $cache_value ) {
$site_ids = $this->get_site_ids();
$this->set_found_sites();
'found_sites' => $this->found_sites,
wp_cache_add( $cache_key, $cache_value, 'site-queries' );
$site_ids = $cache_value['site_ids'];
$this->found_sites = $cache_value['found_sites'];
if ( $this->found_sites && $this->query_vars['number'] ) {
$this->max_num_pages = (int) ceil( $this->found_sites / $this->query_vars['number'] );
// If querying for a count only, there's nothing more to do.
if ( $this->query_vars['count'] ) {
// $site_ids is actually a count in this case.
$site_ids = array_map( 'intval', $site_ids );
if ( $this->query_vars['update_site_meta_cache'] ) {
wp_lazyload_site_meta( $site_ids );
if ( 'ids' === $this->query_vars['fields'] ) {
$this->sites = $site_ids;
// Prime site network caches.
if ( $this->query_vars['update_site_cache'] ) {
_prime_site_caches( $site_ids, false );
// Fetch full site objects from the primed cache.
foreach ( $site_ids as $site_id ) {
$_site = get_site( $site_id );
* Filters the site query results.
* @param WP_Site[] $_sites An array of WP_Site objects.
* @param WP_Site_Query $query Current instance of WP_Site_Query (passed by reference).
$_sites = apply_filters_ref_array( 'the_sites', array( $_sites, &$this ) );
// Convert to WP_Site instances.
$this->sites = array_map( 'get_site', $_sites );
* Used internally to get a list of site IDs matching the query vars.
* @global wpdb $wpdb WordPress database abstraction object.
* @return int|array A single count of site IDs if a count query. An array of site IDs if a full query.
protected function get_site_ids() {
$order = $this->parse_order( $this->query_vars['order'] );
// Disable ORDER BY with 'none', an empty array, or boolean false.
if ( in_array( $this->query_vars['orderby'], array( 'none', array(), false ), true ) ) {
} elseif ( ! empty( $this->query_vars['orderby'] ) ) {
$ordersby = is_array( $this->query_vars['orderby'] ) ?
$this->query_vars['orderby'] :
preg_split( '/[,\s]/', $this->query_vars['orderby'] );
$orderby_array = array();
foreach ( $ordersby as $_key => $_value ) {
$parsed = $this->parse_orderby( $_orderby );
if ( 'site__in' === $_orderby || 'network__in' === $_orderby ) {
$orderby_array[] = $parsed;
$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
$orderby = implode( ', ', $orderby_array );
$orderby = "{$wpdb->blogs}.blog_id $order";
$number = absint( $this->query_vars['number'] );
$offset = absint( $this->query_vars['offset'] );
if ( ! empty( $number ) ) {
$limits = 'LIMIT ' . $offset . ',' . $number;
$limits = 'LIMIT ' . $number;
if ( $this->query_vars['count'] ) {
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
