From 6c01c2a864b66511bf137c8e7c588714d4587b28 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 19 Jun 2021 20:57:01 +0000 Subject: [PATCH] Docs: Add a reference to `WP_Site_Query::__construct()` for information on accepted arguments in `get_sites()`. Synchronize the documentation between two places, use `WP_Site_Query::__construct()` as the canonical source. Follow-up to [37616]. Props birgire, felipeelia, audrasjb. Fixes #42156. Built from https://develop.svn.wordpress.org/trunk@51184 git-svn-id: http://core.svn.wordpress.org/trunk@50793 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/class-wp-site-query.php | 2 +- wp-includes/ms-site.php | 47 ++--------------------------- wp-includes/version.php | 2 +- 3 files changed, 4 insertions(+), 47 deletions(-) diff --git a/wp-includes/class-wp-site-query.php b/wp-includes/class-wp-site-query.php index 39e689b464..4a9a585b2f 100644 --- a/wp-includes/class-wp-site-query.php +++ b/wp-includes/class-wp-site-query.php @@ -152,7 +152,7 @@ class WP_Site_Query { * @type string[] $lang__in Array of language IDs to include affiliated sites for. Default empty. * @type string[] $lang__not_in Array of language IDs to exclude affiliated sites for. 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'. + * @type string[] $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 true. * @type bool $update_site_meta_cache Whether to prime the metadata cache for found sites. Default true. diff --git a/wp-includes/ms-site.php b/wp-includes/ms-site.php index 9a5b2ad43a..2c8c93cb86 100644 --- a/wp-includes/ms-site.php +++ b/wp-includes/ms-site.php @@ -410,51 +410,8 @@ function update_sitemeta_cache( $site_ids ) { * * @see WP_Site_Query::parse_query() * - * @param string|array $args { - * Optional. Array or query string of site query parameters. Default empty. - * - * @type int[] $site__in Array of site IDs to include. Default empty. - * @type int[] $site__not_in Array of site IDs to exclude. Default empty. - * @type bool $count Whether to return a site count (true) or array of site objects. - * 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' (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 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. - * @type string|array $orderby Site status or array of statuses. Accepts 'id', 'domain', 'path', - * 'network_id', 'last_updated', 'registered', 'domain_length', - * 'path_length', 'site__in' and 'network__in'. Also accepts false, - * 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. If 0, - * include all networks. Default 0. - * @type int[] $network__in Array of network IDs to include affiliated sites for. Default empty. - * @type int[] $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. - * @type string[] $domain__in Array of domains to include affiliated sites for. Default empty. - * @type string[] $domain__not_in Array of domains to exclude affiliated sites for. Default empty. - * @type string $path Limit results to those affiliated with a given path. Default empty. - * @type string[] $path__in Array of paths to include affiliated sites for. Default empty. - * @type string[] $path__not_in Array of paths to exclude affiliated sites for. Default empty. - * @type int $public Limit results to public sites. Accepts '1' or '0'. Default empty. - * @type int $archived Limit results to archived sites. Accepts '1' or '0'. Default empty. - * @type int $mature Limit results to mature sites. Accepts '1' or '0'. Default empty. - * @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 int $lang_id Limit results to a language ID. Default empty. - * @type string[] $lang__in Array of language IDs to include affiliated sites for. Default empty. - * @type string[] $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty. - * @type string $search Search term(s) to retrieve matching sites for. Default empty. - * @type string[] $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 true. - * } + * @param string|array $args Optional. Array or string of arguments. See WP_Site_Query::__construct() + * for information on accepted arguments. Default empty array. * @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. */ diff --git a/wp-includes/version.php b/wp-includes/version.php index d18b29ef6a..fe98f7a925 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.8-beta2-51183'; +$wp_version = '5.8-beta2-51184'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.