W3cubDocs

/WordPress

WP_Network_Query::__construct( string|array $query = '' )

Constructor.

Description

Sets up the network query, based on the query vars passed.

Parameters

$query

(string|array) (Optional) Array or query string of network query parameters.

  • 'network__in'
    (array) Array of network IDs to include.
  • 'network__not_in'
    (array) Array of network IDs to exclude.
  • 'count'
    (bool) Whether to return a network count (true) or array of network objects. Default false.
  • 'fields'
    (string) Network fields to return. Accepts 'ids' (returns an array of network IDs) or empty (returns an array of complete network objects).
  • 'number'
    (int) Maximum number of networks to retrieve. Default empty (no limit).
  • 'offset'
    (int) Number of networks to offset the query. Used to build LIMIT clause. Default 0.
  • 'no_found_rows'
    (bool) Whether to disable the SQL_CALC_FOUND_ROWS query. Default true.
  • 'orderby'
    (string|array) Network status or array of statuses. Accepts 'id', 'domain', 'path', 'domain_length', 'path_length' and 'network__in'. Also accepts false, an empty array, or 'none' to disable ORDER BY clause. Default 'id'.
  • 'order'
    (string) How to order retrieved networks. Accepts 'ASC', 'DESC'. Default 'ASC'.
  • 'domain'
    (string) Limit results to those affiliated with a given domain.
  • 'domain__in'
    (array) Array of domains to include affiliated networks for.
  • 'domain__not_in'
    (array) Array of domains to exclude affiliated networks for.
  • 'path'
    (string) Limit results to those affiliated with a given path.
  • 'path__in'
    (array) Array of paths to include affiliated networks for.
  • 'path__not_in'
    (array) Array of paths to exclude affiliated networks for.
  • 'search'
    (string) Search term(s) to retrieve matching networks for.
  • 'update_network_cache'
    (bool) Whether to prime the cache for found networks. Default true.

Default value: ''

Source

File: wp-includes/class-wp-network-query.php 

public function __construct( $query = '' ) {
		$this->query_var_defaults = array(
			'network__in'          => '',
			'network__not_in'      => '',
			'count'                => false,
			'fields'               => '',
			'number'               => '',
			'offset'               => '',
			'no_found_rows'        => true,
			'orderby'              => 'id',
			'order'                => 'ASC',
			'domain'               => '',
			'domain__in'           => '',
			'domain__not_in'       => '',
			'path'                 => '',
			'path__in'             => '',
			'path__not_in'         => '',
			'search'               => '',
			'update_network_cache' => true,
		);

		if ( ! empty( $query ) ) {
			$this->query( $query );
		}
	}

Uses

Uses Description
wp-includes/class-wp-network-query.php: WP_Network_Query::query()

Sets up the WordPress query for retrieving networks.

Used By

Used By Description
wp-admin/includes/class-wp-debug-data.php: WP_Debug_Data::debug_data()

Static function for generating site debug data when required.
wp-includes/ms-network.php: get_networks()

Retrieves a list of networks.

Changelog

Version Description
4.6.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/WP_Network_Query/__construct