Changeset 41918

Timestamp:

10/18/2017 06:12:20 PM (8 years ago)

Author:

flixos90

Message:

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.

Location:

trunk/src/wp-includes

Files:

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

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

@@ -171 +171 @@
      *
      * @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 ) {
@@ -183 +184 @@
      * @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() {

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

@@ -1117 +1117 @@
  * @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() ) {