vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-04-07 14:14:36 +00:00
Code Issues Actions Packages 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@41912 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jeremy Felt
2017-10-18 17:38:35 +00:00
parent d3df7a6a18
commit d4bdbbf542
2 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/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();