Changeset 41912 for trunk/src/wp-includes/ms-blogs.php

Timestamp:

10/18/2017 05:38:35 PM (8 years ago)

Author:

jeremyfelt

Message:

Multisite: Document all return types in get_sites().

Adds more complete documentation to get_sites() and the corresponding methods in WP_Site_Query.

Fixes #41789.

File:

• trunk/src/wp-includes/ms-blogs.php (modified) (1 diff)

trunk/src/wp-includes/ms-blogs.php

@@ -637 +637 @@
  *     @type bool         $update_site_cache Whether to prime the cache for found sites. Default true.
  * }
- * @return array|int List of sites, or number of sites when 'count' is passed as a query var.
+ * @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.
  */
 function get_sites( $args = array() ) {