WP_Site_Query::__construct() │ public │ WP 4.6.0

Sets up the site query, based on the query vars passed.

Method of the class: WP_Site_Query{}

No Hooks.

Return

null. Nothing (null).

Usage

$WP_Site_Query = new WP_Site_Query();
$WP_Site_Query->__construct( $query );

$query(string|array)

Array or query string of site query parameters.

Default: ''

• site__in(int[])
  Array of site IDs to include.
  Default: ''

• site__not_in(int[])
  Array of site IDs to exclude.
  Default: ''

• count(true|false)
  Whether to return a site count (true) or array of site objects.
  Default: false

• date_query(array)
  Date query clauses to limit sites by. See WP_Date_Query.
  Default: null

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

• ID(int)
  A site ID to only return that site.
  Default: ''

• number(int)
  Maximum number of sites to retrieve.
  Default: 100

• offset(int)
  Number of sites to offset the query. Used to build LIMIT clause.

• no_found_rows(true|false)
  Whether to disable the SQL_CALC_FOUND_ROWS query.
  Default: true

• orderby(string|array)
  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.
    Default: 'id'

• order(string)
  How to order retrieved sites. Accepts 'ASC', 'DESC'.
  Default: 'ASC'

• network_id(int)
  Limit results to those affiliated with a given network ID. If 0, include all networks.

• network__in(int[])
  Array of network IDs to include affiliated sites for.
  Default: ''

• network__not_in(int[])
  Array of network IDs to exclude affiliated sites for.
  Default: ''

• domain(string)
  Limit results to those affiliated with a given domain.
  Default: ''

• domain__in(string[])
  Array of domains to include affiliated sites for.
  Default: ''

• domain__not_in(string[])
  Array of domains to exclude affiliated sites for.
  Default: ''

• path(string)
  Limit results to those affiliated with a given path.
  Default: ''

• path__in(string[])
  Array of paths to include affiliated sites for.
  Default: ''

• path__not_in(string[])
  Array of paths to exclude affiliated sites for.
  Default: ''

• public(int)
  Limit results to public sites. Accepts 1 or 0.
  Default: ''

• archived(int)
  Limit results to archived sites. Accepts 1 or 0.
  Default: ''

• mature(int)
  Limit results to mature sites. Accepts 1 or 0.
  Default: ''

• spam(int)
  Limit results to spam sites. Accepts 1 or 0.
  Default: ''

• deleted(int)
  Limit results to deleted sites. Accepts 1 or 0.
  Default: ''

• lang_id(int)
  Limit results to a language ID.
  Default: ''

• lang__in(string[])
  Array of language IDs to include affiliated sites for.
  Default: ''

• lang__not_in(string[])
  Array of language IDs to exclude affiliated sites for.
  Default: ''

• search(string)
  Search term(s) to retrieve matching sites for.
  Default: ''

• search_columns(string[])
  Array of column names to be searched. Accepts 'domain' and 'path'.
  Default: empty array

• update_site_cache(true|false)
  Whether to prime the cache for found sites.
  Default: true

• update_site_meta_cache(true|false)
  Whether to prime the metadata cache for found sites.
  Default: true

• meta_key(string|string[])
  Meta key or keys to filter by.

• meta_value(string|string[])
  Meta value or values to filter by.

• meta_compare(string)
  MySQL operator used for comparing the meta value. See WP_Meta_Query::__construct() for accepted values and default value.

• meta_compare_key(string)
  MySQL operator used for comparing the meta key. See WP_Meta_Query::__construct() for accepted values and default value.

• meta_type(string)
  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_key(string)
  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_query(array)
  An associative array of WP_Meta_Query arguments. See WP_Meta_Query::__construct() for accepted values.

Changelog

WP_Site_Query::__construct() WP Site Query:: construct code ^{WP 6.6.2}

public function __construct( $query = '' ) {
	$this->query_var_defaults = array(
		'fields'                 => '',
		'ID'                     => '',
		'site__in'               => '',
		'site__not_in'           => '',
		'number'                 => 100,
		'offset'                 => '',
		'no_found_rows'          => true,
		'orderby'                => 'id',
		'order'                  => 'ASC',
		'network_id'             => 0,
		'network__in'            => '',
		'network__not_in'        => '',
		'domain'                 => '',
		'domain__in'             => '',
		'domain__not_in'         => '',
		'path'                   => '',
		'path__in'               => '',
		'path__not_in'           => '',
		'public'                 => null,
		'archived'               => null,
		'mature'                 => null,
		'spam'                   => null,
		'deleted'                => null,
		'lang_id'                => null,
		'lang__in'               => '',
		'lang__not_in'           => '',
		'search'                 => '',
		'search_columns'         => array(),
		'count'                  => false,
		'date_query'             => null, // See WP_Date_Query.
		'update_site_cache'      => true,
		'update_site_meta_cache' => true,
		'meta_query'             => '',
		'meta_key'               => '',
		'meta_value'             => '',
		'meta_type'              => '',
		'meta_compare'           => '',
	);

	if ( ! empty( $query ) ) {
		$this->query( $query );
	}
}