get_sites( string|array $args = array() )
Retrieves a list of sites matching requested arguments.
Contents
Description Description
See also See also
Parameters Parameters
- $args
-
(string|array) (Optional) Array or string of arguments. See WP_Site_Query::__construct() for information on accepted arguments.
Default value: array()
Return 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 Source
File: wp-includes/ms-site.php
function get_sites( $args = array() ) {
$query = new WP_Site_Query();
return $query->query( $args );
}
Expand full source code Collapse full source code View on Trac View on GitHub
Changelog Changelog
| Version | Description |
|---|---|
| 4.8.0 | Introduced the 'lang_id', 'lang__in', and 'lang__not_in' parameters. |
| 4.6.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
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; }Expand full source codeCollapse full source code
Top ↑
Feedback #Feedback
Please note that without specifying a ‘number’ attribute, this will only affect the first 100 sites! — By Stevish —
Beware, using
get_sites()as a drop-in forwp_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.phpIt’s true that
get_sites()returns an array, however, it produces an array of sites as objects. This is different fromwp_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
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/
Top ↑
Feedback #Feedback
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? — By ldigregorio —