mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-08-11 20:30:23 +00:00
Multisite: Introduce metadata for sites.
A new global multisite table `wp_blogmeta` is added to the database schema, and a set of `*_site_meta()` API functions are introduced. The implementation fails gracefully when the new table is not yet available, which may happen especially shortly after the core update, before the network has been upgraded to the new database schema. The presence of the table is detected once and stored as a global setting on the main network. Core does not yet use site metadata, but there are several use-cases to be implemented or explored in the near future, and it allows plugins to extend sites with arbitrary data, which will come in particularly handy with the upcoming REST API endpoint for sites. Props spacedmonkey, johnjamesjacoby, jeremyfelt, flixos90. Fixes #37923. git-svn-id: https://develop.svn.wordpress.org/trunk@42836 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Felix Arntz
@@ -92,86 +92,89 @@ class WP_Site_Query {
|
||||
*
|
||||
* @since 4.6.0
|
||||
* @since 4.8.0 Introduced the 'lang_id', 'lang__in', and 'lang__not_in' parameters.
|
||||
* @since 5.0.0 Introduced the 'update_site_meta_cache' parameter.
|
||||
*
|
||||
* @param string|array $query {
|
||||
* Optional. Array or query string of site query parameters. Default empty.
|
||||
*
|
||||
* @type array $site__in Array of site IDs to include. Default empty.
|
||||
* @type array $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 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.
|
||||
* @type array $domain__in Array of domains to include affiliated sites for. Default empty.
|
||||
* @type array $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 array $path__in Array of paths to include affiliated sites for. Default empty.
|
||||
* @type array $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 array $lang__in Array of language IDs to include affiliated sites for. Default empty.
|
||||
* @type array $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'.
|
||||
* Default empty array.
|
||||
* @type bool $update_site_cache Whether to prime the cache for found sites. Default true.
|
||||
* @type array $site__in Array of site IDs to include. Default empty.
|
||||
* @type array $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 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.
|
||||
* @type array $domain__in Array of domains to include affiliated sites for. Default empty.
|
||||
* @type array $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 array $path__in Array of paths to include affiliated sites for. Default empty.
|
||||
* @type array $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 array $lang__in Array of language IDs to include affiliated sites for. Default empty.
|
||||
* @type array $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'.
|
||||
* 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.
|
||||
* }
|
||||
*/
|
||||
public function __construct( $query = '' ) {
|
||||
$this->query_var_defaults = array(
|
||||
'fields' => '',
|
||||
'ID' => '',
|
||||
'site__in' => '',
|
||||
'site__not_in' => '',
|
||||
'number' => 100,
|
||||
'offset' => '',
|
||||
'no_found_rows' => true,
|
||||
'orderby' => 'id',
|
||||
'order' => 'ASC',
|
||||
'network_id' => 0,
|
||||
'network__in' => '',
|
||||
'network__not_in' => '',
|
||||
'domain' => '',
|
||||
'domain__in' => '',
|
||||
'domain__not_in' => '',
|
||||
'path' => '',
|
||||
'path__in' => '',
|
||||
'path__not_in' => '',
|
||||
'public' => null,
|
||||
'archived' => null,
|
||||
'mature' => null,
|
||||
'spam' => null,
|
||||
'deleted' => null,
|
||||
'lang_id' => null,
|
||||
'lang__in' => '',
|
||||
'lang__not_in' => '',
|
||||
'search' => '',
|
||||
'search_columns' => array(),
|
||||
'count' => false,
|
||||
'date_query' => null, // See WP_Date_Query
|
||||
'update_site_cache' => true,
|
||||
'fields' => '',
|
||||
'ID' => '',
|
||||
'site__in' => '',
|
||||
'site__not_in' => '',
|
||||
'number' => 100,
|
||||
'offset' => '',
|
||||
'no_found_rows' => true,
|
||||
'orderby' => 'id',
|
||||
'order' => 'ASC',
|
||||
'network_id' => 0,
|
||||
'network__in' => '',
|
||||
'network__not_in' => '',
|
||||
'domain' => '',
|
||||
'domain__in' => '',
|
||||
'domain__not_in' => '',
|
||||
'path' => '',
|
||||
'path__in' => '',
|
||||
'path__not_in' => '',
|
||||
'public' => null,
|
||||
'archived' => null,
|
||||
'mature' => null,
|
||||
'spam' => null,
|
||||
'deleted' => null,
|
||||
'lang_id' => null,
|
||||
'lang__in' => '',
|
||||
'lang__not_in' => '',
|
||||
'search' => '',
|
||||
'search_columns' => array(),
|
||||
'count' => false,
|
||||
'date_query' => null, // See WP_Date_Query
|
||||
'update_site_cache' => true,
|
||||
'update_site_meta_cache' => true,
|
||||
);
|
||||
|
||||
if ( ! empty( $query ) ) {
|
||||
@@ -288,7 +291,7 @@ class WP_Site_Query {
|
||||
|
||||
// Prime site network caches.
|
||||
if ( $this->query_vars['update_site_cache'] ) {
|
||||
_prime_site_caches( $site_ids );
|
||||
_prime_site_caches( $site_ids, $this->query_vars['update_site_meta_cache'] );
|
||||
}
|
||||
|
||||
// Fetch full site objects from the primed cache.
|
||||
|
||||
Reference in New Issue
Block a user