Changeset 25862

Timestamp:

10/22/2013 05:47:15 AM (11 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation for the wp_get_sites() return value.

Fixes #25645.

File:

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

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

@@ -2067 +2067 @@
 
 /**
- * Return an array of sites for a network.
- *
- * @see wp_is_large_network() Returns an empty array if the install is considered large.
+ * Return an array of sites for a network or networks.
  *
  * @since 3.7.0
  *
  * @param array $args {
- *     Array of arguments. Optional.
- *
- *     @type int|array 'network_id' A network ID or array of network IDs. Set to null to retrieve sites
- *                                  from all networks. Defaults to current network ID.
- *     @type int       'public'     Retrieve public or non-public sites. Default null, for any.
- *     @type int       'archived'   Retrieve archived or non-archived sites. Default null, for any.
- *     @type int       'mature'     Retrieve mature or non-mature sites. Default null, for any.
- *     @type int       'spam'       Retrieve spam or non-spam sites. Default null, for any.
- *     @type int       'deleted'    Retrieve deleted or non-deleted sites. Default null, for any.
- *     @type int       'limit'      Number of sites to limit the query to. Default 100.
- *     @type int       'offset'     Exclude the first x sites. Used in combination with the limit parameter. Default 0.
+ *     Array of default arguments. Optional.
+ *
+ *     @type int|array $network_id A network ID or array of network IDs. Set to null to retrieve sites
+ *                                 from all networks. Defaults to current network ID.
+ *     @type int       $public     Retrieve public or non-public sites. Default null, for any.
+ *     @type int       $archived   Retrieve archived or non-archived sites. Default null, for any.
+ *     @type int       $mature     Retrieve mature or non-mature sites. Default null, for any.
+ *     @type int       $spam       Retrieve spam or non-spam sites. Default null, for any.
+ *     @type int       $deleted    Retrieve deleted or non-deleted sites. Default null, for any.
+ *     @type int       $limit      Number of sites to limit the query to. Default 100.
+ *     @type int       $offset     Exclude the first x sites. Used in combination with the $limit parameter. Default 0.
  * }
- *
- * @return array An array of site data
+ * @return array An empty array if the install is considered "large" via wp_is_large_network(). Otherwise,
+ *               an associative array of site data arrays, each containing the site (network) ID, blog ID,
+ *               site domain and path, dates registered and modified, and the language ID. Also, boolean
+ *               values for whether the site is public, archived, mature, spam, and/or deleted.
  */
 function wp_get_sites( $args = array() ) {