W3cubDocs

/WordPress

get_sites( string|array $args = array() )

Retrieves a list of sites matching requested arguments.

Description

See also

Parameters

$args

(string|array) (Optional) Array or query string of site query parameters.

  • 'site__in'
    (array) Array of site IDs to include.
  • 'site__not_in'
    (array) 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 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).
  • '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 query. Used to build LIMIT clause. Default 0.
  • 'no_found_rows'
    (bool) 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. Default 0.
  • 'network__in'
    (array) Array of network IDs to include affiliated sites for.
  • 'network__not_in'
    (array) Array of network IDs to exclude affiliated sites for.
  • 'domain'
    (string) Limit results to those affiliated with a given domain.
  • 'domain__in'
    (array) Array of domains to include affiliated sites for.
  • 'domain__not_in'
    (array) Array of domains to exclude affiliated sites for.
  • 'path'
    (string) Limit results to those affiliated with a given path.
  • 'path__in'
    (array) Array of paths to include affiliated sites for.
  • 'path__not_in'
    (array) Array of paths to exclude affiliated sites for.
  • 'public'
    (int) Limit results to public sites. Accepts '1' or '0'.
  • 'archived'
    (int) Limit results to archived sites. Accepts '1' or '0'.
  • 'mature'
    (int) Limit results to mature sites. Accepts '1' or '0'.
  • 'spam'
    (int) Limit results to spam sites. Accepts '1' or '0'.
  • 'deleted'
    (int) Limit results to deleted sites. Accepts '1' or '0'.
  • 'lang_id'
    (int) Limit results to a language ID.
  • 'lang__in'
    (array) Array of language IDs to include affiliated sites for.
  • 'lang__not_in'
    (array) Array of language IDs to exclude affiliated sites for.
  • 'search'
    (string) Search term(s) to retrieve matching sites for.
  • 'search_columns'
    (array) Array of column names to be searched. Accepts 'domain' and 'path'.
  • 'update_site_cache'
    (bool) Whether to prime the cache for found sites. Default true.

Default value: array()

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.

Source

File: wp-includes/ms-site.php 

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

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

Uses

Uses Description
wp-includes/class-wp-site-query.php: WP_Site_Query::__construct()

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

Used By

Used By Description
wp-includes/embed.php: get_oembed_response_data_for_url()

Retrieves the oEmbed response data for a given URL.
wp-includes/class-wp-network.php: WP_Network::get_main_site_id()

Returns the main site ID for the network.
wp-admin/includes/class-wp-ms-sites-list-table.php: WP_MS_Sites_List_Table::prepare_items()

Prepares the list of sites for display.
wp-admin/includes/class-wp-importer.php: WP_Importer::set_blog()
wp-includes/user.php: get_blogs_of_user()

Get the sites a user belongs to.
wp-includes/ms-deprecated.php: wp_get_sites()

Return an array of sites for a network or networks.
wp-includes/ms-functions.php: wp_update_network_site_counts()

Update the network-wide site count.
wp-includes/ms-functions.php: domain_exists()

Checks whether a site name is already taken.
wp-includes/ms-functions.php: get_blog_id_from_url()

Get a blog’s numeric ID from its URL.
wp-includes/ms-load.php: get_site_by_path()

Retrieves the closest matching site object by its domain and path.
wp-includes/ms-blogs.php: get_id_from_blogname()

Retrieves a sites ID given its (subdomain or directory) slug.

Changelog

Version Description
4.8.0 Introduced the 'lang_id', 'lang__in', and 'lang__not_in' parameters.
4.6.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_sites