WP_Network_Query::get_networks(): array|int

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

array|int

List of WP_Network objects, a list of network IDs when 'fields' is set to 'ids', or the number of networks when 'count' is passed as a query var.

Performance profile

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

Moderate

Only touches the object cache, via wp_cache_get_last_changed().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

21–121

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

Plugin surface

3 hooks

Third-party callbacks on 'pre_get_networks', 'networks_pre_query', 'the_networks' 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 callbacksdo_action_ref_array()called directly
• cacheobject cachewp_cache_get_last_changed()called directly
• serializeserialisationserialize()called directly

What one call costs · 25 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while WP_Network_Query::get_networks() runs, in this order:

1. 1
   do_action( pre_get_networks )actionline 208 (+10 into the body)

   Fires before networks are retrieved.

2. 2
   apply_filters( networks_pre_query )filterline 242 (+44 into the body)

   Filters the network data before the query takes place.

3. 3
   apply_filters( the_networks )filterline 318 (+120 into the body)

   Filters the network query results.

Uses · 11

• do_action_ref_array()Calls the callback functions that have been added to an action hook, specifying arguments in an array.
• apply_filters_ref_array()Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
• wp_array_slice_assoc()Extracts a slice of an array, given a list of keys.
• wp_cache_get_last_changed()Gets last changed date for the specified cache group.
• wp_cache_get_salted()Retrieves cached data if valid and unchanged.
• wp_cache_set_salted()Stores salted data in the cache.
• _prime_network_caches()Adds any networks from the given IDs to the cache that do not already exist in cache.
• get_network()Retrieves network data given a network ID or network object.
• WP_Network_Query::parse_query()Parses arguments passed to the network query with default query parameters.
• WP_Network_Query::get_network_ids()Used internally to get a list of network IDs matching the query vars.
• WP_Network_Query::set_found_networks()Populates found_networks and max_num_pages properties for the current query if the limit clause was used.

Used by · 1

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

Source code

View on Trac ↗View on GitHub ↗

198	public function get_networks() {199		$this->parse_query();200 201		/**202		 * Fires before networks are retrieved.203		 *204		 * @since 4.6.0205		 *206		 * @param WP_Network_Query $query Current instance of WP_Network_Query (passed by reference).207		 */208		do_action_ref_array( 'pre_get_networks', array( &$this ) );209 210		$network_data = null;211 212		/**213		 * Filters the network data before the query takes place.214		 *215		 * Return a non-null value to bypass WordPress' default network queries.216		 *217		 * The expected return type from this filter depends on the value passed218		 * in the request query vars:219		 * - When `$this->query_vars['count']` is set, the filter should return220		 *   the network count as an integer.221		 * - When `'ids' === $this->query_vars['fields']`, the filter should return222		 *   an array of network IDs.223		 * - Otherwise the filter should return an array of WP_Network objects.224		 *225		 * Note that if the filter returns an array of network data, it will be assigned226		 * to the `networks` property of the current WP_Network_Query instance.227		 *228		 * Filtering functions that require pagination information are encouraged to set229		 * the `found_networks` and `max_num_pages` properties of the WP_Network_Query object,230		 * passed to the filter by reference. If WP_Network_Query does not perform a database231		 * query, it will not have enough information to generate these values itself.232		 *233		 * @since 5.2.0234		 * @since 5.6.0 The returned array of network data is assigned to the `networks` property235		 *              of the current WP_Network_Query instance.236		 *237		 * @param array|int|null   $network_data Return an array of network data to short-circuit WP's network query,238		 *                                       the network count as an integer if `$this->query_vars['count']` is set,239		 *                                       or null to allow WP to run its normal queries.240		 * @param WP_Network_Query $query        The WP_Network_Query instance, passed by reference.241		 */242		$network_data = apply_filters_ref_array( 'networks_pre_query', array( $network_data, &$this ) );243 244		if ( null !== $network_data ) {245			if ( is_array( $network_data ) && ! $this->query_vars['count'] ) {246				$this->networks = $network_data;247			}248 249			return $network_data;250		}251 252		// $args can include anything. Only use the args defined in the query_var_defaults to compute the key.253		$_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );254 255		// Ignore the $fields, $update_network_cache arguments as the queried result will be the same regardless.256		unset( $_args['fields'], $_args['update_network_cache'] );257 258		$key          = md5( serialize( $_args ) );259		$last_changed = wp_cache_get_last_changed( 'networks' );260 261		$cache_key   = "get_network_ids:$key";262		$cache_value = wp_cache_get_salted( $cache_key, 'network-queries', $last_changed );263 264		if ( false === $cache_value ) {265			$network_ids = $this->get_network_ids();266			if ( $network_ids ) {267				$this->set_found_networks();268			}269 270			$cache_value = array(271				'network_ids'    => $network_ids,272				'found_networks' => $this->found_networks,273			);274			wp_cache_set_salted( $cache_key, $cache_value, 'network-queries', $last_changed );275		} else {276			$network_ids          = $cache_value['network_ids'];277			$this->found_networks = $cache_value['found_networks'];

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.