3
* Network API: WP_Network_Query class
6
* @subpackage Multisite
11
* Core class used for querying networks.
15
* @see WP_Network_Query::__construct() for accepted arguments.
17
class WP_Network_Query {
20
* SQL for database query.
35
protected $sql_clauses = array(
45
* Query vars set by the user.
54
* Default values for query vars.
60
public $query_var_defaults;
63
* List of networks located by the query.
72
* The amount of found networks for the current query.
78
public $found_networks = 0;
81
* The number of pages.
87
public $max_num_pages = 0;
92
* Sets up the network query, based on the query vars passed.
97
* @param string|array $query {
98
* Optional. Array or query string of network query parameters. Default empty.
100
* @type array $network__in Array of network IDs to include. Default empty.
101
* @type array $network__not_in Array of network IDs to exclude. Default empty.
102
* @type bool $count Whether to return a network count (true) or array of network objects.
104
* @type string $fields Network fields to return. Accepts 'ids' (returns an array of network IDs)
105
* or empty (returns an array of complete network objects). Default empty.
106
* @type int $number Maximum number of networks to retrieve. Default null (no limit).
107
* @type int $offset Number of networks to offset the query. Used to build LIMIT clause.
109
* @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true.
110
* @type string|array $orderby Network status or array of statuses. Accepts 'id', 'domain', 'path',
111
* 'domain_length', 'path_length' and 'network__in'. Also accepts false,
112
* an empty array, or 'none' to disable `ORDER BY` clause. Default 'id'.
113
* @type string $order How to order retrieved networks. Accepts 'ASC', 'DESC'. Default 'ASC'.
114
* @type string $domain Limit results to those affiliated with a given network ID.
115
* Default current network ID.
116
* @type array $domain__in Array of domains to include affiliated networks for. Default empty.
117
* @type array $domain__not_in Array of domains to exclude affiliated networks for. Default empty.
118
* @type string $path Limit results to those affiliated with a given network ID.
119
* Default current network ID.
120
* @type array $path__in Array of paths to include affiliated networks for. Default empty.
121
* @type array $path__not_in Array of paths to exclude affiliated networks for. Default empty.
122
* @type string $search Search term(s) to retrieve matching networks for. Default empty.
123
* @type bool $update_network_cache Whether to prime the cache for found networks. Default true.
126
public function __construct( $query = '' ) {
127
$this->query_var_defaults = array(
129
'network__not_in' => '',
134
'no_found_rows' => true,
139
'domain__not_in' => '',
142
'path__not_in' => '',
144
'update_network_cache' => true,
147
if ( ! empty( $query ) ) {
148
$this->query( $query );
153
* Parses arguments passed to the network query with default query parameters.
159
* @param string|array $query WP_Network_Query arguments. See WP_Network_Query::__construct()
161
public function parse_query( $query = '' ) {
162
if ( empty( $query ) ) {
163
$query = $this->query_vars;
166
$this->query_vars = wp_parse_args( $query, $this->query_var_defaults );
169
* Fires after the network query vars have been parsed.
173
* @param WP_Network_Query &$this The WP_Network_Query instance (passed by reference).
175
do_action_ref_array( 'parse_network_query', array( &$this ) );
179
* Sets up the WordPress query for retrieving networks.
184
* @param string|array $query Array or URL query string of parameters.
185
* @return array|int List of networks, or number of networks when 'count' is passed as a query var.
187
public function query( $query ) {
188
$this->query_vars = wp_parse_args( $query );
189
return $this->get_networks();
193
* Gets a list of networks matching the query vars.
198
* @return int|array The list of networks.
200
public function get_networks() {
201
$this->parse_query();
204
* Fires before networks are retrieved.
208
* @param WP_Network_Query &$this Current instance of WP_Network_Query, passed by reference.
210
do_action_ref_array( 'pre_get_networks', array( &$this ) );
212
// $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
213
$key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) ) ) );
214
$last_changed = wp_cache_get( 'last_changed', 'networks' );
215
if ( ! $last_changed ) {
216
$last_changed = microtime();
217
wp_cache_set( 'last_changed', $last_changed, 'networks' );
220
$cache_key = "get_network_ids:$key:$last_changed";
221
$cache_value = wp_cache_get( $cache_key, 'networks' );
223
if ( false === $cache_value ) {
224
$network_ids = $this->get_network_ids();
225
if ( $network_ids ) {
226
$this->set_found_networks();
229
$cache_value = array(
230
'network_ids' => $network_ids,
231
'found_networks' => $this->found_networks,
233
wp_cache_add( $cache_key, $cache_value, 'networks' );
235
$network_ids = $cache_value['network_ids'];
236
$this->found_networks = $cache_value['found_networks'];
239
if ( $this->found_networks && $this->query_vars['number'] ) {
240
$this->max_num_pages = ceil( $this->found_networks / $this->query_vars['number'] );
243
// If querying for a count only, there's nothing more to do.
244
if ( $this->query_vars['count'] ) {
245
// $network_ids is actually a count in this case.
246
return intval( $network_ids );
249
$network_ids = array_map( 'intval', $network_ids );
251
if ( 'ids' == $this->query_vars['fields'] ) {
252
$this->networks = $network_ids;
253
return $this->networks;
256
if ( $this->query_vars['update_network_cache'] ) {
257
_prime_network_caches( $network_ids );
260
// Fetch full network objects from the primed cache.
261
$_networks = array();
262
foreach ( $network_ids as $network_id ) {
263
if ( $_network = get_network( $network_id ) ) {
264
$_networks[] = $_network;
269
* Filters the network query results.
273
* @param array $results An array of networks.
274
* @param WP_Network_Query &$this Current instance of WP_Network_Query, passed by reference.
276
$_networks = apply_filters_ref_array( 'the_networks', array( $_networks, &$this ) );
278
// Convert to WP_Network instances
279
$this->networks = array_map( 'get_network', $_networks );
281
return $this->networks;
285
* Used internally to get a list of network IDs matching the query vars.
290
* @return int|array A single count of network IDs if a count query. An array of network IDs if a full query.
292
protected function get_network_ids() {
295
$order = $this->parse_order( $this->query_vars['order'] );
297
// Disable ORDER BY with 'none', an empty array, or boolean false.
298
if ( in_array( $this->query_vars['orderby'], array( 'none', array(), false ), true ) ) {
300
} elseif ( ! empty( $this->query_vars['orderby'] ) ) {
301
$ordersby = is_array( $this->query_vars['orderby'] ) ?
302
$this->query_vars['orderby'] :
303
preg_split( '/[,\s]/', $this->query_vars['orderby'] );
305
$orderby_array = array();
306
foreach ( $ordersby as $_key => $_value ) {
311
if ( is_int( $_key ) ) {
319
$parsed = $this->parse_orderby( $_orderby );
325
if ( 'network__in' === $_orderby ) {
326
$orderby_array[] = $parsed;
330
$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
333
$orderby = implode( ', ', $orderby_array );
335
$orderby = "$wpdb->site.id $order";
338
$number = absint( $this->query_vars['number'] );
339
$offset = absint( $this->query_vars['offset'] );
341
if ( ! empty( $number ) ) {
343
$limits = 'LIMIT ' . $offset . ',' . $number;
345
$limits = 'LIMIT ' . $number;
349
if ( $this->query_vars['count'] ) {
350
$fields = 'COUNT(*)';
352
$fields = "$wpdb->site.id";
355
// Parse network IDs for an IN clause.
356
if ( ! empty( $this->query_vars['network__in'] ) ) {
357
$this->sql_clauses['where']['network__in'] = "$wpdb->site.id IN ( " . implode( ',', wp_parse_id_list( $this->query_vars['network__in'] ) ) . ' )';
360
// Parse network IDs for a NOT IN clause.
361
if ( ! empty( $this->query_vars['network__not_in'] ) ) {
362
$this->sql_clauses['where']['network__not_in'] = "$wpdb->site.id NOT IN ( " . implode( ',', wp_parse_id_list( $this->query_vars['network__not_in'] ) ) . ' )';
365
if ( ! empty( $this->query_vars['domain'] ) ) {
366
$this->sql_clauses['where']['domain'] = $wpdb->prepare( "$wpdb->site.domain = %s", $this->query_vars['domain'] );
369
// Parse network domain for an IN clause.
370
if ( is_array( $this->query_vars['domain__in'] ) ) {
371
$this->sql_clauses['where']['domain__in'] = "$wpdb->site.domain IN ( '" . implode( "', '", $wpdb->_escape( $this->query_vars['domain__in'] ) ) . "' )";
374
// Parse network domain for a NOT IN clause.
375
if ( is_array( $this->query_vars['domain__not_in'] ) ) {
376
$this->sql_clauses['where']['domain__not_in'] = "$wpdb->site.domain NOT IN ( '" . implode( "', '", $wpdb->_escape( $this->query_vars['domain__not_in'] ) ) . "' )";
379
if ( ! empty( $this->query_vars['path'] ) ) {
380
$this->sql_clauses['where']['path'] = $wpdb->prepare( "$wpdb->site.path = %s", $this->query_vars['path'] );
383
// Parse network path for an IN clause.
384
if ( is_array( $this->query_vars['path__in'] ) ) {
385
$this->sql_clauses['where']['path__in'] = "$wpdb->site.path IN ( '" . implode( "', '", $wpdb->_escape( $this->query_vars['path__in'] ) ) . "' )";
388
// Parse network path for a NOT IN clause.
389
if ( is_array( $this->query_vars['path__not_in'] ) ) {
390
$this->sql_clauses['where']['path__not_in'] = "$wpdb->site.path NOT IN ( '" . implode( "', '", $wpdb->_escape( $this->query_vars['path__not_in'] ) ) . "' )";
393
// Falsey search strings are ignored.
394
if ( strlen( $this->query_vars['search'] ) ) {
395
$this->sql_clauses['where']['search'] = $this->get_search_sql(
396
$this->query_vars['search'],
397
array( "$wpdb->site.domain", "$wpdb->site.path" )
403
$where = implode( ' AND ', $this->sql_clauses['where'] );
405
$pieces = array( 'fields', 'join', 'where', 'orderby', 'limits', 'groupby' );
408
* Filters the network query clauses.
412
* @param array $pieces A compacted array of network query clauses.
413
* @param WP_Network_Query &$this Current instance of WP_Network_Query, passed by reference.
415
$clauses = apply_filters_ref_array( 'networks_clauses', array( compact( $pieces ), &$this ) );
417
$fields = isset( $clauses['fields'] ) ? $clauses['fields'] : '';
418
$join = isset( $clauses['join'] ) ? $clauses['join'] : '';
419
$where = isset( $clauses['where'] ) ? $clauses['where'] : '';
420
$orderby = isset( $clauses['orderby'] ) ? $clauses['orderby'] : '';
421
$limits = isset( $clauses['limits'] ) ? $clauses['limits'] : '';
422
$groupby = isset( $clauses['groupby'] ) ? $clauses['groupby'] : '';
425
$where = 'WHERE ' . $where;
429
$groupby = 'GROUP BY ' . $groupby;
433
$orderby = "ORDER BY $orderby";
437
if ( ! $this->query_vars['no_found_rows'] ) {
438
$found_rows = 'SQL_CALC_FOUND_ROWS';
441
$this->sql_clauses['select'] = "SELECT $found_rows $fields";
442
$this->sql_clauses['from'] = "FROM $wpdb->site $join";
443
$this->sql_clauses['groupby'] = $groupby;
444
$this->sql_clauses['orderby'] = $orderby;
445
$this->sql_clauses['limits'] = $limits;
447
$this->request = "{$this->sql_clauses['select']} {$this->sql_clauses['from']} {$where} {$this->sql_clauses['groupby']} {$this->sql_clauses['orderby']} {$this->sql_clauses['limits']}";
449
if ( $this->query_vars['count'] ) {
450
return intval( $wpdb->get_var( $this->request ) );
453
$network_ids = $wpdb->get_col( $this->request );
455
return array_map( 'intval', $network_ids );
459
* Populates found_networks and max_num_pages properties for the current query
460
* if the limit clause was used.
465
* @global wpdb $wpdb WordPress database abstraction object.
467
private function set_found_networks() {
470
if ( $this->query_vars['number'] && ! $this->query_vars['no_found_rows'] ) {
472
* Filters the query used to retrieve found network count.
476
* @param string $found_networks_query SQL query. Default 'SELECT FOUND_ROWS()'.
477
* @param WP_Network_Query $network_query The `WP_Network_Query` instance.
479
$found_networks_query = apply_filters( 'found_networks_query', 'SELECT FOUND_ROWS()', $this );
481
$this->found_networks = (int) $wpdb->get_var( $found_networks_query );
486
* Used internally to generate an SQL string for searching across multiple columns.
491
* @global wpdb $wpdb WordPress database abstraction object.
493
* @param string $string Search string.
494
* @param array $columns Columns to search.
496
* @return string Search SQL.
498
protected function get_search_sql( $string, $columns ) {
501
$like = '%' . $wpdb->esc_like( $string ) . '%';
504
foreach ( $columns as $column ) {
505
$searches[] = $wpdb->prepare( "$column LIKE %s", $like );
508
return '(' . implode( ' OR ', $searches ) . ')';
512
* Parses and sanitizes 'orderby' keys passed to the network query.
517
* @global wpdb $wpdb WordPress database abstraction object.
519
* @param string $orderby Alias for the field to order by.
520
* @return string|false Value to used in the ORDER clause. False otherwise.
522
protected function parse_orderby( $orderby ) {
525
$allowed_keys = array(
532
if ( $orderby == 'network__in' ) {
533
$network__in = implode( ',', array_map( 'absint', $this->query_vars['network__in'] ) );
534
$parsed = "FIELD( {$wpdb->site}.id, $network__in )";
535
} elseif ( $orderby == 'domain_length' || $orderby == 'path_length' ) {
536
$field = substr( $orderby, 0, -7 );
537
$parsed = "CHAR_LENGTH($wpdb->site.$field)";
538
} elseif ( in_array( $orderby, $allowed_keys ) ) {
539
$parsed = "$wpdb->site.$orderby";
546
* Parses an 'order' query variable and cast it to 'ASC' or 'DESC' as necessary.
551
* @param string $order The 'order' query variable.
552
* @return string The sanitized 'order' query variable.
554
protected function parse_order( $order ) {
555
if ( ! is_string( $order ) || empty( $order ) ) {
559
if ( 'ASC' === strtoupper( $order ) ) {
added
removed
wp-includes/class-wp-network-query.php
