WP_Site_Query::get_site_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 site IDs if a count query. An array of site IDs if a full query.

Performance profile

How much work a call to WP_Site_Query::get_site_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

237–251

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

Plugin surface

2 hooks

Third-party callbacks on 'site_search_columns', 'sites_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()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_Site_Query::get_site_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 · 2

2 hooks fire while WP_Site_Query::get_site_ids() runs, in this order:

1. 1
   apply_filters( site_search_columns )filterline 627 (+187 into the body)

   Filters the columns to search in a WP_Site_Query search.

2. 2
   apply_filters( sites_clauses )filterline 675 (+235 into the body)

   Filters the site query clauses.

Uses · 8

• 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()Calls the callback functions that have been added to a filter hook.
• apply_filters_ref_array()Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
• WP_Site_Query::parse_order()Parses an 'order' query variable and cast it to 'ASC' or 'DESC' as necessary.
• WP_Site_Query::parse_orderby()Parses and sanitizes 'orderby' keys passed to the site query.
• WP_Site_Query::get_search_sql()Used internally to generate an SQL string for searching across multiple columns.
• WP_Date_Query::__construct()Constructor.

Used by · 1

• WP_Site_Query::get_sites()Retrieves a list of sites matching the query vars.

Source code

View on Trac ↗View on GitHub ↗

440	protected function get_site_ids() {441		global $wpdb;442 443		$order = $this->parse_order( $this->query_vars['order'] );444 445		// Disable ORDER BY with 'none', an empty array, or boolean false.446		if ( in_array( $this->query_vars['orderby'], array( 'none', array(), false ), true ) ) {447			$orderby = '';448		} elseif ( ! empty( $this->query_vars['orderby'] ) ) {449			$ordersby = is_array( $this->query_vars['orderby'] ) ?450				$this->query_vars['orderby'] :451				preg_split( '/[,\s]/', $this->query_vars['orderby'] );452 453			$orderby_array = array();454			foreach ( $ordersby as $_key => $_value ) {455				if ( ! $_value ) {456					continue;457				}458 459				if ( is_int( $_key ) ) {460					$_orderby = $_value;461					$_order   = $order;462				} else {463					$_orderby = $_key;464					$_order   = $_value;465				}466 467				$parsed = $this->parse_orderby( $_orderby );468 469				if ( ! $parsed ) {470					continue;471				}472 473				if ( 'site__in' === $_orderby || 'network__in' === $_orderby ) {474					$orderby_array[] = $parsed;475					continue;476				}477 478				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );479			}480 481			$orderby = implode( ', ', $orderby_array );482		} else {483			$orderby = "{$wpdb->blogs}.blog_id $order";484		}485 486		$number = absint( $this->query_vars['number'] );487		$offset = absint( $this->query_vars['offset'] );488		$limits = '';489 490		if ( ! empty( $number ) ) {491			if ( $offset ) {492				$limits = 'LIMIT ' . $offset . ',' . $number;493			} else {494				$limits = 'LIMIT ' . $number;495			}496		}497 498		if ( $this->query_vars['count'] ) {499			$fields = 'COUNT(*)';500		} else {501			$fields = "{$wpdb->blogs}.blog_id";502		}503 504		// Parse site IDs for an IN clause.505		$site_id = absint( $this->query_vars['ID'] );506		if ( ! empty( $site_id ) ) {507			$this->sql_clauses['where']['ID'] = $wpdb->prepare( "{$wpdb->blogs}.blog_id = %d", $site_id );508		}509 510		// Parse site IDs for an IN clause.511		if ( ! empty( $this->query_vars['site__in'] ) ) {512			$this->sql_clauses['where']['site__in'] = "{$wpdb->blogs}.blog_id IN ( " . implode( ',', wp_parse_id_list( $this->query_vars['site__in'] ) ) . ' )';513		}514 515		// Parse site IDs for a NOT IN clause.516		if ( ! empty( $this->query_vars['site__not_in'] ) ) {517			$this->sql_clauses['where']['site__not_in'] = "{$wpdb->blogs}.blog_id NOT IN ( " . implode( ',', wp_parse_id_list( $this->query_vars['site__not_in'] ) ) . ' )';518		}519

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