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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$querystring|arrayoptional

Array or query string of network query parameters. Default empty.Default: ''

• $network__inint[]default: empty

  Array of network IDs to include.

• $network__not_inint[]default: empty

  Array of network IDs to exclude.

• $countbooldefault: false

  Whether to return a network count (true) or array of network objects.

• $fieldsstringdefault: empty

  Network fields to return. Accepts 'ids' (returns an array of network IDs) or empty (returns an array of complete network objects).

• $numberintdefault: empty (no limit)

  Maximum number of networks to retrieve.

• $offsetintdefault: 0

  Number of networks to offset the query. Used to build LIMIT clause.

• $no_found_rowsbooldefault: true

  Whether to disable the SQL_CALC_FOUND_ROWS query.

• $orderbystring|arraydefault: 'id'

  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.

• $orderstringdefault: 'ASC'

  How to order retrieved networks. Accepts 'ASC', 'DESC'.

• $domainstringdefault: empty

  Limit results to those affiliated with a given domain.

• $domain__instring[]default: empty

  Array of domains to include affiliated networks for.

• $domain__not_instring[]default: empty

  Array of domains to exclude affiliated networks for.

• $pathstringdefault: empty

  Limit results to those affiliated with a given path.

• $path__instring[]default: empty

  Array of paths to include affiliated networks for.

• $path__not_instring[]default: empty

  Array of paths to exclude affiliated networks for.

• $searchstringdefault: empty

  Search term(s) to retrieve matching networks for.

• $update_network_cachebooldefault: true

  Whether to prime the cache for found networks.

Performance profile

How much work a call to WP_Network_Query::__construct() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Reaches the database via ->query().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

6–9

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 9.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• sqldatabase query->query()called directly

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Network_Query::__construct() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• WP_Network_Query::query()Sets up the WordPress query for retrieving networks.

Used by · 2

• WP_Debug_Data::get_wp_core()Gets the WordPress core section of the debug data.
• get_networks()Retrieves a list of networks.

Source code

View on Trac ↗View on GitHub ↗

117	public function __construct( $query = '' ) {118		$this->query_var_defaults = array(119			'network__in'          => '',120			'network__not_in'      => '',121			'count'                => false,122			'fields'               => '',123			'number'               => '',124			'offset'               => '',125			'no_found_rows'        => true,126			'orderby'              => 'id',127			'order'                => 'ASC',128			'domain'               => '',129			'domain__in'           => '',130			'domain__not_in'       => '',131			'path'                 => '',132			'path__in'             => '',133			'path__not_in'         => '',134			'search'               => '',135			'update_network_cache' => true,136		);137 138		if ( ! empty( $query ) ) {139			$this->query( $query );140		}141	}

Changelog

Introduced in 4.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-network-query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.