From 8533eae95a43b924d681ef9405e708807fc3bd61 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Tue, 13 Sep 2016 13:19:57 +0000 Subject: [PATCH] Docs: Synchronize docblocks for `WP_Site_Query::__construct()` and `get_sites()` after the changes in [37735], [38008], [38103], and [38336]. Props MaximeCulea. Fixes #38039. git-svn-id: https://develop.svn.wordpress.org/trunk@38596 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/ms-blogs.php | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/ms-blogs.php b/src/wp-includes/ms-blogs.php index 7f9d481718..51a1ae51b2 100644 --- a/src/wp-includes/ms-blogs.php +++ b/src/wp-includes/ms-blogs.php @@ -566,10 +566,10 @@ function update_site_cache( $sites ) { * Default false. * @type array $date_query Date query clauses to limit sites by. See WP_Date_Query. * Default null. - * @type string $fields Site fields to return. Accepts 'ids' for site IDs only or empty - * for all fields. Default empty. + * @type string $fields Site fields to return. Accepts 'ids' (returns an array of site IDs) + * or empty (returns an array of complete site objects). Default empty. * @type int $ID A site ID to only return that site. Default empty. - * @type int $number Maximum number of sites to retrieve. Default null (no limit). + * @type int $number Maximum number of sites to retrieve. Default 100. * @type int $offset Number of sites to offset the query. Used to build LIMIT clause. * Default 0. * @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true. @@ -579,8 +579,8 @@ function update_site_cache( $sites ) { * an empty array, or 'none' to disable `ORDER BY` clause. * Default 'id'. * @type string $order How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'. - * @type int $network_id Limit results to those affiliated with a given network ID. - * Default current network ID. + * @type int $network_id Limit results to those affiliated with a given network ID. If 0, + * include all networks. Default 0. * @type array $network__in Array of network IDs to include affiliated sites for. Default empty. * @type array $network__not_in Array of network IDs to exclude affiliated sites for. Default empty. * @type string $domain Limit results to those affiliated with a given domain. Default empty. @@ -595,6 +595,8 @@ function update_site_cache( $sites ) { * @type int $spam Limit results to spam sites. Accepts '1' or '0'. Default empty. * @type int $deleted Limit results to deleted sites. Accepts '1' or '0'. Default empty. * @type string $search Search term(s) to retrieve matching sites for. Default empty. + * @type array $search_columns Array of column names to be searched. Accepts 'domain' and 'path'. + * Default empty array. * @type bool $update_site_cache Whether to prime the cache for found sites. Default false. * } * @return array List of sites.