get_sites() – Function | Developer.WordPress.org

Retrieves a list of sites matching requested arguments.

Description

Parameters

$argsstring|arrayoptional: Array or string of arguments. See WP_Site_Query::__construct() for information on accepted arguments.
Default:array()

Return

WP_Site[]|int[]|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

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

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

View all references View on Trac View on GitHub

Uses	Description
WP_Site_Query::__construct()`wp-includes/class-wp-site-query.php`	Sets up the site query, based on the query vars passed.

Used by	Description
get_oembed_response_data_for_url()`wp-includes/embed.php`	Retrieves the oEmbed response data for a given URL.
WP_Network::get_main_site_id()`wp-includes/class-wp-network.php`	Returns the main site ID for the network.
WP_MS_Sites_List_Table::prepare_items()`wp-admin/includes/class-wp-ms-sites-list-table.php`	Prepares the list of sites for display.
WP_Importer::set_blog()`wp-admin/includes/class-wp-importer.php`
get_blogs_of_user()`wp-includes/user.php`	Gets the sites a user belongs to.
wp_update_network_site_counts()`wp-includes/ms-functions.php`	Updates the network-wide site count.
wp_get_sites()`wp-includes/ms-deprecated.php`	Return an array of sites for a network or networks.
domain_exists()`wp-includes/ms-functions.php`	Checks whether a site name is already taken.
get_blog_id_from_url()`wp-includes/ms-functions.php`	Gets a blog’s numeric ID from its URL.
get_site_by_path()`wp-includes/ms-load.php`	Retrieves the closest matching site object by its domain and path.
get_id_from_blogname()`wp-includes/ms-blogs.php`	Retrieves a site’s ID given its (subdomain or directory) slug.

Show 6 more Show less

Changelog

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

User Contributed Notes

Lance Cleveland 9 years ago

Also good to know… get_sites now returns an OBJECT not a named array.

A code example that may help:

// WordPress 4.6
//
if ( function_exists( 'get_sites' ) && class_exists( 'WP_Site_Query' ) ) {
	$sites = get_sites();
	foreach ( $sites as $site ) {
		switch_to_blog( $site-&gt;blog_id );
                // do something
		restore_current_blog();
	}
	return;
}

// WordPress &lt; 4.6
//
if ( function_exists( 'wp_get_sites' ) ) {
	$sites = wp_get_sites();
	foreach ( $sites as $site ) {
		switch_to_blog( $site['blog_id'] );
                // do something
		restore_current_blog();
	}
	return;
}

Please note that without specifying a ‘number’ attribute, this will only affect the first 100 sites!

Stevish 6 years ago

Skip to note 6 content

mkormendy 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
Beware, using get_sites() as a drop-in for wp_get_sites() may not produce results as expected.

PHP Fatal error: Cannot use object of type WP_Site as array in /path/to/code/that/uses/get_sites/method/file.php

It’s true that get_sites() returns an array, however, it produces an array of sites as objects. This is different from wp_get_sites(), which used to produce a multidimensional array of the sites, with their properties in a secondary array dimension (simply an array of site arrays with that site’s properties).

If you’re attempting to loop through the sites to get the properties of each site with get_sites() , you’ll need to convert each site object to an array using get_object_vars( object ) http://www.php.net/manual/en/function.get-object-vars.php.

See the example below noting the use of get_object_vars on line three:
```
$subsites = get_sites();
foreach( $subsites as $subsite ) {
  $subsite_id = get_object_vars($subsite)["blog_id"];
  $subsite_name = get_blog_details($subsite_id)->blogname;
  echo 'Site ID/Name: ' . $subsite_id . ' / ' . $subsite_name . '\n';
}
```
This should return the following list of sites:

Site ID/Name: 1 / SiteNameOne
Site ID/Name: 2 / SiteNameTwo
Site ID/Name: 3 / SiteNameThree
Log in to add feedback
Skip to note 7 content

Lance Cleveland 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

wp_get_sites() ‘limit’ argument is now ‘number’.

wp_get_sites() converted this to $args[‘number’] for you, get_sites() does not appear to handle this parameter name conversion for you.

Reference: https://developer.wordpress.org/reference/functions/wp_get_sites/
- I’m seeing public = -2 in the query return. This is contrary to what is expected, either a 0 or a 1 Why is that?
  
  ldigregorio 5 years ago
Log in to add feedback
Skip to note 8 content

Clicknathan 1 year ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
The number of sites returned is limited to 100 by default. you can increase this using number.
```
$args = array(
	'number' => 420,
);
$blog_list = get_sites( $args );
```
Note that -1 (often used to “get all”) does not appear to work here.
Log in to add feedback

get_sites( string|array $args = array() ): WP_Site[]|int[]|int

In this article