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

Timestamp:

11/05/2019 09:21:46 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

File:

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

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

@@ -860 +860 @@
  * @since 5.3.0
  *
- * @param int $network_id The network to get counts for.  Default is the current network id.
- * @return array Includes a grand total 'all' and an array of counts indexed by
- *                status strings: public, archived, mature, spam, deleted.
+ * @param int $network_id Optional. The network to get counts for. Default is the current network ID.
+ * @return int[] {
+ *     Numbers of sites grouped by site status.
+ *
+ *     @type int $all      The total number of sites.
+ *     @type int $public   The number of public sites.
+ *     @type int $archived The number of archived sites.
+ *     @type int $mature   The number of mature sites.
+ *     @type int $spam     The number of spam sites.
+ *     @type int $deleted  The number of deleted sites.
+ * }
  */
 function wp_count_sites( $network_id = null ) {