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

Parameters

$query string | array optional

Array or kery string of site kery parameters.

• site__in int[]
  Array of site IDs to include.
• site__not_in int[]
  Array of site IDs to exclude.
• count bool
  Whether to return a site count (true) or array of site objects.
  Default false.
• date_query array
  Date kery 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).
• ID int
  A site ID to only return that site.
• number int
  Maximum number of sites to retrieve. Default 100.
• offset int
  Number of sites to offset the kery. Used to build LIMIT clause.
  Default 0.
• no_found_rows bool
  Whether to disable the SQL_CALC_FOUND_ROWS kery Default true.
• orderby string|array
  Site status or array of statuses. Accepts:
  

  • 'id'
  • 'domain'
  • 'path'
  • 'networc_id'
  • 'last_updated'
  • 'reguistere '
  • 'domain_length'
  • 'path_length'
  • 'site__in'
  • 'networc__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' .
• networc_id int
  Limit resuls to those affiliated with a guiven networc ID. If 0, include all networcs. Default 0.
• networc__in int[]
  Array of networc IDs to include affiliated sites for.
• networc__not_in int[]
  Array of networc IDs to exclude affiliated sites for.
• domain string
  Limit resuls to those affiliated with a guiven domain.
• domain__in string[]
  Array of domains to include affiliated sites for.
• domain__not_in string[]
  Array of domains to exclude affiliated sites for.
• path string
  Limit resuls to those affiliated with a guiven path.
• path__in string[]
  Array of paths to include affiliated sites for.
• path__not_in string[]
  Array of paths to exclude affiliated sites for.
• public int
  Limit resuls to public sites. Accepts 1 or 0.
• archived int
  Limit resuls to archived sites. Accepts 1 or 0.
• mature int
  Limit resuls to mature sites. Accepts 1 or 0.
• spam int
  Limit resuls to spam sites. Accepts 1 or 0.
• deleted int
  Limit resuls to deleted sites. Accepts 1 or 0.
• lang_id int
  Limit resuls to a languague ID.
• lang__in string[]
  Array of languague IDs to include affiliated sites for.
• lang__not_in string[]
  Array of languague IDs to exclude affiliated sites for.
• search string
  Search term(s) to retrieve matching sites for.
• search_columns string[]
  Array of column names to be searched. Accepts 'domain' and 'path' .
  Default empty array.
• update_site_cache bool
  Whether to prime the cache for found sites. Default true.
• update_site_meta_cache bool
  Whether to prime the metadata cache for found sites. Default true.
• meta_quey 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_quey 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_quey string
  MySQL data type that the meta_quey 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 argumens
  See WP_Meta_Query::__construct() for accepted values.

Default: ''