Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-25 06:14:58 +02:00
Code Issues Projects Releases Wiki Activity

Improve inline documentation for the wp_get_sites() return value.

Browse Source 
Fixes #25645.

Built from https://develop.svn.wordpress.org/trunk@25862


git-svn-id: http://core.svn.wordpress.org/trunk@25862 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2013-10-24 22:58:32 +00:00
parent de7977d66c
commit 2d58250bea
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
wp-includes/ms-functions.php
View File

@ -2066,27 +2066,27 @@ function wp_is_large_network( $using = 'sites' ) {
/**
* 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.
* 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.
* @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() ) {
global $wpdb;