WP_Site_Query::__construct( string|array $query = '' )

Compatibility

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

Parameters

$querystring|arrayoptional

Array or query string of site query parameters. Default empty.Default: ''

• $site__inint[]default: empty

  Array of site IDs to include.

• $site__not_inint[]default: empty

  Array of site IDs to exclude.

• $countbooldefault: false

  Whether to return a site count (true) or array of site objects.

• $date_queryarraydefault: null

  Date query clauses to limit sites by. See WP_Date_Query.

• $fieldsstringdefault: empty

  Site fields to return. Accepts 'ids' (returns an array of site IDs) or empty (returns an array of complete site objects).

• $IDintdefault: empty

  A site ID to only return that site.

• $numberintdefault: 100

  Maximum number of sites to retrieve.

• $offsetintdefault: 0

  Number of sites to offset the query. Used to build LIMIT clause.

• $no_found_rowsbooldefault: true

  Whether to disable the SQL_CALC_FOUND_ROWS query.

• $orderbystring|arraydefault: 'id'

  Site status or array of statuses. Accepts: - 'id' - 'domain' - 'path' - 'network_id' - 'last_updated' - 'registered' - 'domain_length' - 'path_length' - 'site__in' - 'network__in' - 'deleted' - 'mature' - 'spam' - 'archived' - 'public' - false, an empty array, or 'none' to disable ORDER BY clause.

• $orderstringdefault: 'ASC'

  How to order retrieved sites. Accepts 'ASC', 'DESC'.

• $network_idintdefault: 0

  Limit results to those affiliated with a given network ID. If 0, include all networks.

• $network__inint[]default: empty

  Array of network IDs to include affiliated sites for.

• $network__not_inint[]default: empty

  Array of network IDs to exclude affiliated sites for.

• $domainstringdefault: empty

  Limit results to those affiliated with a given domain.

• $domain__instring[]default: empty

  Array of domains to include affiliated sites for.

• $domain__not_instring[]default: empty

  Array of domains to exclude affiliated sites for.

• $pathstringdefault: empty

  Limit results to those affiliated with a given path.

• $path__instring[]default: empty

  Array of paths to include affiliated sites for.

• $path__not_instring[]default: empty

  Array of paths to exclude affiliated sites for.

• $publicintdefault: empty

  Limit results to public sites. Accepts 1 or 0.

• $archivedintdefault: empty

  Limit results to archived sites. Accepts 1 or 0.

• $matureintdefault: empty

  Limit results to mature sites. Accepts 1 or 0.

• $spamintdefault: empty

  Limit results to spam sites. Accepts 1 or 0.

• $deletedintdefault: empty

  Limit results to deleted sites. Accepts 1 or 0.

• $lang_idintdefault: empty

  Limit results to a language ID.

• $lang__instring[]default: empty

  Array of language IDs to include affiliated sites for.

• $lang__not_instring[]default: empty

  Array of language IDs to exclude affiliated sites for.

• $searchstringdefault: empty

  Search term(s) to retrieve matching sites for.

• $search_columnsstring[]default: empty array

  Array of column names to be searched. Accepts 'domain' and 'path'.

• $update_site_cachebooldefault: true

  Whether to prime the cache for found sites.

• $update_site_meta_cachebooldefault: true

  Whether to prime the metadata cache for found sites.

• $meta_keystring|string[]

  Meta key or keys to filter by.

• $meta_valuestring|string[]

  Meta value or values to filter by.

• $meta_comparestring

  MySQL operator used for comparing the meta value. See WP_Meta_Query::construct() for accepted values and default value.

• $meta_compare_keystring

  MySQL operator used for comparing the meta key. See WP_Meta_Query::</strong>construct() for accepted values and default value.

• $meta_typestring

  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.

• $meta_type_keystring

  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.

• $meta_queryarray

  An associative array of WP_Meta_Query arguments. See WP_Meta_Query::</strong>construct() for accepted values.

Performance profile

How much work a call to WP_Site_Query::__construct() 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

Trivial

Reaches the database via ->query().

Scaling

Constant

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

Instructions

6–9

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

What it touches

• sqldatabase query->query()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::__construct() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• WP_Site_Query::query()Sets up the WordPress query for retrieving sites.

Used by · 2

• get_sites()Retrieves a list of sites matching requested arguments.
• wp_count_sites()Counts number of sites grouped by site status.

Source code

View on Trac ↗View on GitHub ↗

188	public function __construct( $query = '' ) {189		$this->query_var_defaults = array(190			'fields'                 => '',191			'ID'                     => '',192			'site__in'               => '',193			'site__not_in'           => '',194			'number'                 => 100,195			'offset'                 => '',196			'no_found_rows'          => true,197			'orderby'                => 'id',198			'order'                  => 'ASC',199			'network_id'             => 0,200			'network__in'            => '',201			'network__not_in'        => '',202			'domain'                 => '',203			'domain__in'             => '',204			'domain__not_in'         => '',205			'path'                   => '',206			'path__in'               => '',207			'path__not_in'           => '',208			'public'                 => null,209			'archived'               => null,210			'mature'                 => null,211			'spam'                   => null,212			'deleted'                => null,213			'lang_id'                => null,214			'lang__in'               => '',215			'lang__not_in'           => '',216			'search'                 => '',217			'search_columns'         => array(),218			'count'                  => false,219			'date_query'             => null, // See WP_Date_Query.220			'update_site_cache'      => true,221			'update_site_meta_cache' => true,222			'meta_query'             => '',223			'meta_key'               => '',224			'meta_value'             => '',225			'meta_type'              => '',226			'meta_compare'           => '',227		);228 229		if ( ! empty( $query ) ) {230			$this->query( $query );231		}232	}

Changelog

Introduced in 5.3.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.