WP_Network_Query::get_network_ids(): int|array

Return

int|array

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

Hooks fired · 1

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

1. 1
   apply_filters( networks_clauses )filterline 461 (+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

View on Trac ↗View on GitHub ↗

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

History

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.