sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Multisite: Document all return types in get_networks(). 

Adds more complete documentation to get_networks() and the corresponding methods in WP_Network_Query.

Fixes #42260.


git-svn-id: https://develop.svn.wordpress.org/trunk@41918 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Felix Arntz 2017-10-18 18:12:20 +00:00
parent a540d91f8f
commit 4124fbfa7c
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/wp-includes/class-wp-network-query.php
View File

@ -170,7 +170,8 @@ class WP_Network_Query {
* @since 4.6.0
*
* @param string|array $query Array or URL query string of parameters.
* @return array|int List of networks, or number of networks when 'count' is passed as a query var.
* @return array|int List of WP_Network objects, a list of network ids when 'fields' is set to 'ids',
* or the number of networks when 'count' is passed as a query var.
*/
public function query( $query ) {
$this->query_vars = wp_parse_args( $query );
@ -182,7 +183,8 @@ class WP_Network_Query {
*
* @since 4.6.0
*
* @return int|array The list of networks.
* @return array|int List of WP_Network objects, a list of network ids when 'fields' is set to 'ids',
* or the number of networks when 'count' is passed as a query var.
*/
public function get_networks() {
$this->parse_query();

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

@ -1116,7 +1116,8 @@ function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) {
*
* @param string|array $args Optional. Array or string of arguments. See WP_Network_Query::parse_query()
* for information on accepted arguments. Default empty array.
* @return int|array List of networks or number of found networks if `$count` argument is true.
* @return array|int List of WP_Network objects, a list of network ids when 'fields' is set to 'ids',
* or the number of networks when 'count' is passed as a query var.
*/
function get_networks( $args = array() ) {
$query = new WP_Network_Query();