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

User Contributed Notes

1. Skip to note 5 content

   Lance Cleveland 9 years ago

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

   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->blog_id );
                   // do something
   		restore_current_blog();
   	}
   	return;
   }
   
   // WordPress < 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 7 years ago
2. 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 ) https://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
3. 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 6 years ago
4. Skip to note 8 content

   Clicknathan 2 years 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.