Make WordPress Core


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/ms-functions.php

    r25621 r25862  
    20672067
    20682068/**
    2069  * Return an array of sites for a network.
    2070  *
    2071  * @see wp_is_large_network() Returns an empty array if the install is considered large.
     2069 * Return an array of sites for a network or networks.
    20722070 *
    20732071 * @since 3.7.0
    20742072 *
    20752073 * @param array $args {
    2076  *     Array of arguments. Optional.
    2077  *
    2078  *     @type int|array 'network_id' A network ID or array of network IDs. Set to null to retrieve sites
    2079  *                                  from all networks. Defaults to current network ID.
    2080  *     @type int       'public'     Retrieve public or non-public sites. Default null, for any.
    2081  *     @type int       'archived'   Retrieve archived or non-archived sites. Default null, for any.
    2082  *     @type int       'mature'     Retrieve mature or non-mature sites. Default null, for any.
    2083  *     @type int       'spam'       Retrieve spam or non-spam sites. Default null, for any.
    2084  *     @type int       'deleted'    Retrieve deleted or non-deleted sites. Default null, for any.
    2085  *     @type int       'limit'      Number of sites to limit the query to. Default 100.
    2086  *     @type int       'offset'     Exclude the first x sites. Used in combination with the limit parameter. Default 0.
     2074 *     Array of default arguments. Optional.
     2075 *
     2076 *     @type int|array $network_id A network ID or array of network IDs. Set to null to retrieve sites
     2077 *                                 from all networks. Defaults to current network ID.
     2078 *     @type int       $public     Retrieve public or non-public sites. Default null, for any.
     2079 *     @type int       $archived   Retrieve archived or non-archived sites. Default null, for any.
     2080 *     @type int       $mature     Retrieve mature or non-mature sites. Default null, for any.
     2081 *     @type int       $spam       Retrieve spam or non-spam sites. Default null, for any.
     2082 *     @type int       $deleted    Retrieve deleted or non-deleted sites. Default null, for any.
     2083 *     @type int       $limit      Number of sites to limit the query to. Default 100.
     2084 *     @type int       $offset     Exclude the first x sites. Used in combination with the $limit parameter. Default 0.
    20872085 * }
    2088  *
    2089  * @return array An array of site data
     2086 * @return array An empty array if the install is considered "large" via wp_is_large_network(). Otherwise,
     2087 *               an associative array of site data arrays, each containing the site (network) ID, blog ID,
     2088 *               site domain and path, dates registered and modified, and the language ID. Also, boolean
     2089 *               values for whether the site is public, archived, mature, spam, and/or deleted.
    20902090 */
    20912091function wp_get_sites( $args = array() ) {
Note: See TracChangeset for help on using the changeset viewer.