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

Retrieves a list of sites matching requested arguments.

Description

$args

(string|array) (Optional) Array or string of arguments. See WP_Site_Query::__construct() for information on accepted arguments.

Default value: array()

(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.

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

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

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	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.

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

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