From 4cb10267579b22c37fa169915ced0f979370b972 Mon Sep 17 00:00:00 2001 From: Felix Arntz Date: Wed, 18 Oct 2017 18:13:50 +0000 Subject: [PATCH] Multisite: Document all return types in get_networks(). Adds more complete documentation to get_networks() and the corresponding methods in WP_Network_Query. Fixes #42260. Built from https://develop.svn.wordpress.org/trunk@41918 git-svn-id: http://core.svn.wordpress.org/trunk@41752 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/class-wp-network-query.php | 6 ++++-- wp-includes/ms-blogs.php | 3 ++- wp-includes/version.php | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/wp-includes/class-wp-network-query.php b/wp-includes/class-wp-network-query.php index f1a46bec3c..f8ca48f452 100644 --- a/wp-includes/class-wp-network-query.php +++ b/wp-includes/class-wp-network-query.php @@ -170,7 +170,8 @@ class WP_Network_Query { * @since 4.6.0 * * @param string|array $query Array or URL query string of parameters. - * @return array|int List of networks, or number of networks when 'count' is passed as a query var. + * @return array|int List of WP_Network objects, a list of network ids when 'fields' is set to 'ids', + * or the number of networks when 'count' is passed as a query var. */ public function query( $query ) { $this->query_vars = wp_parse_args( $query ); @@ -182,7 +183,8 @@ class WP_Network_Query { * * @since 4.6.0 * - * @return int|array The list of networks. + * @return array|int List of WP_Network objects, a list of network ids when 'fields' is set to 'ids', + * or the number of networks when 'count' is passed as a query var. */ public function get_networks() { $this->parse_query(); diff --git a/wp-includes/ms-blogs.php b/wp-includes/ms-blogs.php index 842d55fa3e..3d63bc5743 100644 --- a/wp-includes/ms-blogs.php +++ b/wp-includes/ms-blogs.php @@ -1116,7 +1116,8 @@ function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) { * * @param string|array $args Optional. Array or string of arguments. See WP_Network_Query::parse_query() * for information on accepted arguments. Default empty array. - * @return int|array List of networks or number of found networks if `$count` argument is true. + * @return array|int List of WP_Network objects, a list of network ids when 'fields' is set to 'ids', + * or the number of networks when 'count' is passed as a query var. */ function get_networks( $args = array() ) { $query = new WP_Network_Query(); diff --git a/wp-includes/version.php b/wp-includes/version.php index 477b22cb25..b1f28db8b8 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.9-beta2-41917'; +$wp_version = '4.9-beta2-41918'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.