WP_Network_Query::get_network_ids(): int|array

Compatibility

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

Return value

int|array

A single count of network IDs if a count query. An array of network IDs if a full query.

Performance profile

How much work a call to WP_Network_Query::get_network_ids() 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

Heavy

Reaches the database via ->get_var().

Scaling

Constant

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

Instructions

176–209

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

Plugin surface

1 hook

Third-party callbacks on 'networks_clauses' run inside this call, and their cost is not bounded by anything here.

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters_ref_array()called directly
• sqldatabase query->get_var()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::get_network_ids() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while WP_Network_Query::get_network_ids() runs, in this order:

1. 1
   apply_filters( networks_clauses )filterline 470 (+135 into the body)

   Filters the network query clauses.

Uses · 6

• absint()Converts a value to non-negative integer.
• wp_parse_id_list()Cleans up an array, comma- or space-separated list of IDs.
• apply_filters_ref_array()Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
• WP_Network_Query::parse_order()Parses an 'order' query variable and cast it to 'ASC' or 'DESC' as necessary.
• WP_Network_Query::parse_orderby()Parses and sanitizes 'orderby' keys passed to the network query.
• WP_Network_Query::get_search_sql()Used internally to generate an SQL string for searching across multiple columns.

Used by · 1

• WP_Network_Query::get_networks()Gets a list of networks matching the query vars.

Source code

View on Trac ↗View on GitHub ↗

335	protected function get_network_ids() {336		global $wpdb;337 338		$order = $this->parse_order( $this->query_vars['order'] );339 340		// Disable ORDER BY with 'none', an empty array, or boolean false.341		if ( in_array( $this->query_vars['orderby'], array( 'none', array(), false ), true ) ) {342			$orderby = '';343		} elseif ( ! empty( $this->query_vars['orderby'] ) ) {344			$ordersby = is_array( $this->query_vars['orderby'] ) ?345				$this->query_vars['orderby'] :346				preg_split( '/[,\s]/', $this->query_vars['orderby'] );347 348			$orderby_array = array();349			foreach ( $ordersby as $_key => $_value ) {350				if ( ! $_value ) {351					continue;352				}353 354				if ( is_int( $_key ) ) {355					$_orderby = $_value;356					$_order   = $order;357				} else {358					$_orderby = $_key;359					$_order   = $_value;360				}361 362				$parsed = $this->parse_orderby( $_orderby );363 364				if ( ! $parsed ) {365					continue;366				}367 368				if ( 'network__in' === $_orderby ) {369					$orderby_array[] = $parsed;370					continue;371				}372 373				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );374			}375 376			$orderby = implode( ', ', $orderby_array );377		} else {378			$orderby = "$wpdb->site.id $order";379		}380 381		$number = absint( $this->query_vars['number'] );382		$offset = absint( $this->query_vars['offset'] );383		$limits = '';384 385		if ( ! empty( $number ) ) {386			if ( $offset ) {387				$limits = 'LIMIT ' . $offset . ',' . $number;388			} else {389				$limits = 'LIMIT ' . $number;390			}391		}392 393		if ( $this->query_vars['count'] ) {394			$fields = 'COUNT(*)';395		} else {396			$fields = "$wpdb->site.id";397		}398 399		// Parse network IDs for an IN clause.400		if ( ! empty( $this->query_vars['network__in'] ) ) {401			$this->sql_clauses['where']['network__in'] = "$wpdb->site.id IN ( " . implode( ',', wp_parse_id_list( $this->query_vars['network__in'] ) ) . ' )';402		}403 404		// Parse network IDs for a NOT IN clause.405		if ( ! empty( $this->query_vars['network__not_in'] ) ) {406			$this->sql_clauses['where']['network__not_in'] = "$wpdb->site.id NOT IN ( " . implode( ',', wp_parse_id_list( $this->query_vars['network__not_in'] ) ) . ' )';407		}408 409		if ( ! empty( $this->query_vars['domain'] ) ) {410			$this->sql_clauses['where']['domain'] = $wpdb->prepare( "$wpdb->site.domain = %s", $this->query_vars['domain'] );411		}412 413		// Parse network domain for an IN clause.414		if ( is_array( $this->query_vars['domain__in'] ) ) {

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 7.1.0 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.