get_sites


get_sites ( $args = array() )

Parameters:
  • (string|array) args { Optional. Array or query string of site query parameters. Default empty. @type array $site__in Array of site IDs to include. Default empty. @type array $site__not_in Array of site IDs to exclude. Default empty. @type bool $count Whether to return a site count (true) or array of site objects. Default false. @type array $date_query Date query clauses to limit sites by. See WP_Date_Query. Default null. @type string $fields Site fields to return. Accepts 'ids' (returns an array of site IDs) or empty (returns an array of complete site objects). Default empty. @type int $ID A site ID to only return that site. Default empty. @type int $number Maximum number of sites to retrieve. Default 100. @type int $offset Number of sites to offset the query. Used to build LIMIT clause. Default 0. @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true. @type string|array $orderby 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'. @type string $order How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'. @type int $network_id Limit results to those affiliated with a given network ID. If 0, include all networks. Default 0. @type array $network__in Array of network IDs to include affiliated sites for. Default empty. @type array $network__not_in Array of network IDs to exclude affiliated sites for. Default empty. @type string $domain Limit results to those affiliated with a given domain. Default empty. @type array $domain__in Array of domains to include affiliated sites for. Default empty. @type array $domain__not_in Array of domains to exclude affiliated sites for. Default empty. @type string $path Limit results to those affiliated with a given path. Default empty. @type array $path__in Array of paths to include affiliated sites for. Default empty. @type array $path__not_in Array of paths to exclude affiliated sites for. Default empty. @type int $public Limit results to public sites. Accepts '1' or '0'. Default empty. @type int $archived Limit results to archived sites. Accepts '1' or '0'. Default empty. @type int $mature Limit results to mature sites. Accepts '1' or '0'. Default empty. @type int $spam Limit results to spam sites. Accepts '1' or '0'. Default empty. @type int $deleted Limit results to deleted sites. Accepts '1' or '0'. Default empty. @type int $lang_id Limit results to a language ID. Default empty. @type array $lang__in Array of language IDs to include affiliated sites for. Default empty. @type array $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty. @type string $search Search term(s) to retrieve matching sites for. Default empty. @type array $search_columns Array of column names to be searched. Accepts 'domain' and 'path'. Default empty array. @type bool $update_site_cache Whether to prime the cache for found sites. Default true. }
See:
  • WP_Site_Query::parse_query()
Returns:
  • (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.
Defined at:
Change Log:
  • 4: .

Description

Retrieves a list of sites matching requested arguments.

Related Functions

get_site, wp_get_sites, get_posts, get_users, get_site_url

Top Google Results

User discussions

wpseek mobile