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

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


Parameters

$query string|array Optional
Array or query string of site query parameters.
  • site__inint[]
    Array of site IDs to include.
  • site__not_inint[]
    Array of site IDs to exclude.
  • countbool
    Whether to return a site count (true) or array of site objects.
    Default false.
  • date_queryarray
    Date query clauses to limit sites by. See WP_Date_Query.
    Default null.
  • fieldsstring
    Site fields to return. Accepts 'ids' (returns an array of site IDs) or empty (returns an array of complete site objects).
  • IDint
    A site ID to only return that site.
  • numberint
    Maximum number of sites to retrieve. Default 100.
  • offsetint
    Number of sites to offset the query. Used to build LIMIT clause.
    Default 0.
  • no_found_rowsbool
    Whether to disable the SQL_CALC_FOUND_ROWS query. Default true.
  • orderbystring|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'.
  • orderstring
    How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'.
  • network_idint
    Limit results to those affiliated with a given network ID. If 0, include all networks. Default 0.
  • network__inint[]
    Array of network IDs to include affiliated sites for.
  • network__not_inint[]
    Array of network IDs to exclude affiliated sites for.
  • domainstring
    Limit results to those affiliated with a given domain.
  • domain__instring[]
    Array of domains to include affiliated sites for.
  • domain__not_instring[]
    Array of domains to exclude affiliated sites for.
  • pathstring
    Limit results to those affiliated with a given path.
  • path__instring[]
    Array of paths to include affiliated sites for.
  • path__not_instring[]
    Array of paths to exclude affiliated sites for.
  • publicint
    Limit results to public sites. Accepts '1' or '0'.
  • archivedint
    Limit results to archived sites. Accepts '1' or '0'.
  • matureint
    Limit results to mature sites. Accepts '1' or '0'.
  • spamint
    Limit results to spam sites. Accepts '1' or '0'.
  • deletedint
    Limit results to deleted sites. Accepts '1' or '0'.
  • lang_idint
    Limit results to a language ID.
  • lang__instring[]
    Array of language IDs to include affiliated sites for.
  • lang__not_instring[]
    Array of language IDs to exclude affiliated sites for.
  • searchstring
    Search term(s) to retrieve matching sites for.
  • search_columnsstring[]
    Array of column names to be searched. Accepts 'domain' and 'path'.
    Default empty array.
  • update_site_cachebool
    Whether to prime the cache for found sites. Default true.
  • update_site_meta_cachebool
    Whether to prime the metadata cache for found sites. Default true.
  • 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::__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::__construct() for accepted values.

Default: ''


Top ↑

Source

File: wp-includes/class-wp-site-query.php. View all references

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


Top ↑

Changelog

Changelog
Version Description
5.3.0 Introduced the 'meta_type_key' parameter.
5.1.0 Introduced the 'update_site_meta_cache', 'meta_query', 'meta_key', 'meta_compare_key', 'meta_value', 'meta_type', and 'meta_compare' parameters.
4.8.0 Introduced the 'lang_id', 'lang__in', and 'lang__not_in' parameters.
4.6.0 Introduced.

Top ↑

User Contributed Notes

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