get_sites() WP 1.0

Retrieves a list of sites matching requested arguments.

No Hooks.

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.

Usage

get_sites( $args );

$args(string/array)

Array or query string of site query parameters.

• $site__in (array)
  Array of site IDs to include.
  Default: ''

• $site__not_in (array)
  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' and 'network__in'. Also accepts 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 (array)
  Array of network IDs to include affiliated sites for.
  Default: ''

• $network__not_in (array)
  Array of network IDs to exclude affiliated sites for.
  Default: ''

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

• $domain__in (array)
  Array of domains to include affiliated sites for.
  Default: ''

• $domain__not_in (array)
  Array of domains to exclude affiliated sites for.
  Default: ''

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

• $path__in (array)
  Array of paths to include affiliated sites for.
  Default: ''

• $path__not_in (array)
  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 (array)
  Array of language IDs to include affiliated sites for.
  Default: ''

• $lang__not_in (array)
  Array of language IDs to exclude affiliated sites for.
  Default: ''

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

• $search_columns (array)
  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

Default: ''

Code of get sites: wp-includes/ms-blogs.php ^{VER 5.0.3}

<?php
function get_sites( $args = array() ) {
	$query = new WP_Site_Query();

	return $query->query( $args );
}

Related Functions

From category: Multisite