Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-11-10 12:50:18 +01:00
Code Issues Projects Releases Wiki Activity

Multisite: Document all return types in get_sites().

Browse Source 
Adds more complete documentation to `get_sites()` and the corresponding methods in `WP_Site_Query`.

Fixes #41789.

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


git-svn-id: http://core.svn.wordpress.org/trunk@41746 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Jeremy Felt 2017-10-18 17:39:46 +00:00
parent 53dba84ec7
commit 548d8c2e0d
3 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
wp-includes/class-wp-site-query.php
View File

@ -211,7 +211,8 @@ class WP_Site_Query {
* @since 4.6.0
*
* @param string|array $query Array or URL query string of parameters.
* @return array|int List of WP_Site objects, or number of sites when 'count' is passed as a query var.
* @return array|int List of WP_Site objects, a list of site ids when 'fields' is set to 'ids',
* or the number of sites when 'count' is passed as a query var.
*/
public function query( $query ) {
$this->query_vars = wp_parse_args( $query );
@ -224,7 +225,8 @@ class WP_Site_Query {
*
* @since 4.6.0
*
* @return array|int List of WP_Site objects, or number of sites when 'count' is passed as a query var.
* @return array|int List of WP_Site objects, a list of site ids when 'fields' is set to 'ids',
* or the number of sites when 'count' is passed as a query var.
*/
public function get_sites() {
$this->parse_query();

3
wp-includes/ms-blogs.php
View File

@ -636,7 +636,8 @@ function update_site_cache( $sites ) {
* Default empty array.
* @type bool $update_site_cache Whether to prime the cache for found sites. Default true.
* }
* @return array|int List of sites, or number of sites when 'count' is passed as a query var.
* @return array|int List of WP_Site objects, a list of site ids when 'fields' is set to 'ids',
* or the number of sites when 'count' is passed as a query var.
*/
function get_sites( $args = array() ) {
$query = new WP_Site_Query();

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.9-beta2-41911';
$wp_version = '4.9-beta2-41912';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.