From d4bdbbf542ee220d02fb94f1cd5ccfed02c8a05c Mon Sep 17 00:00:00 2001 From: Jeremy Felt Date: Wed, 18 Oct 2017 17:38:35 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@41912 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-site-query.php | 6 ++++-- src/wp-includes/ms-blogs.php | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/src/wp-includes/class-wp-site-query.php b/src/wp-includes/class-wp-site-query.php index 6f3de914ae..cf2134d8a4 100644 --- a/src/wp-includes/class-wp-site-query.php +++ b/src/wp-includes/class-wp-site-query.php @@ -211,7 +211,8 @@ class WP_Site_Query { * @since 4.6.0 * * @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 ) { $this->query_vars = wp_parse_args( $query ); @@ -224,7 +225,8 @@ class WP_Site_Query { * * @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() { $this->parse_query(); diff --git a/src/wp-includes/ms-blogs.php b/src/wp-includes/ms-blogs.php index ab98d6e5cb..842d55fa3e 100644 --- a/src/wp-includes/ms-blogs.php +++ b/src/wp-includes/ms-blogs.php @@ -636,7 +636,8 @@ function update_site_cache( $sites ) { * Default empty array. * @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() ) { $query = new WP_Site_Query();