Changeset 41912

Timestamp:

10/18/2017 05:38:35 PM (7 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.

Location:

trunk/src/wp-includes

Files:

• class-wp-site-query.php (modified) (2 diffs)
• ms-blogs.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-site-query.php

@@ -212 +212 @@
      *
      * @param string|array $query Array or URL query string of parameters.
-     * @return array|int List of WP_Site objects, 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.
      */
     public function query( $query ) {
@@ -225 +226 @@
      * @since 4.6.0
      *
-     * @return array|int List of WP_Site objects, 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.
      */
     public function get_sites() {

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() ) {