enmi-conf.org: comparison wp/wp-includes/class-wp-network-query.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	 * Sets up the WordPress query for retrieving networks.
 	 *
 	 * @since 4.6.0
 	 *
 	 * @param string|array $query Array or URL query string of parameters.
-	 * @return array|int List of WP_Network objects, a list of network ids when 'fields' is set to 'ids',
+	 * @return 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.
 	 */
 	public function query( $query ) {
 		$this->query_vars = wp_parse_args( $query );
 		return $this->get_networks();
 	/**
 	 * Gets a list of networks matching the query vars.
 	 *
 	 * @since 4.6.0
 	 *
-	 * @return array|int List of WP_Network objects, a list of network ids when 'fields' is set to 'ids',
+	 * @return 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.
 	 */
 	public function get_networks() {
 		$this->parse_query();
 		 *
 		 * @param WP_Network_Query $this Current instance of WP_Network_Query (passed by reference).
 		 */
 		do_action_ref_array( 'pre_get_networks', array( &$this ) );
-		$network_ids = null;
+		$network_data = null;
 		/**
-		 * Filter the sites array before the query takes place.
+		 * Filter the network data before the query takes place.
 		 *
-		 * Return a non-null value to bypass WordPress's default site queries.
+		 * Return a non-null value to bypass WordPress's default network queries.
 		 *
+		 * The expected return type from this filter depends on the value passed in the request query_vars.
+		 * When `$this->query_vars['count']` is set, the filter should return the network count as an int.
+		 * When `'ids' === $this->query_vars['fields']`, the filter should return an array of network IDs.
+		 * Otherwise the filter should return an array of WP_Network objects.
 		 *
 		 * @since 5.2.0
 		 *
-		 * @param array|null       $site_ids Return an array of site data to short-circuit WP's site query,
+		 * @param array|null       $network_data Return an array of network data to short-circuit WP's network query,
-		 *                                   or null to allow WP to run its normal queries.
+		 *                                       the network count as an integer if `$this->query_vars['count']` is set,
-		 * @param WP_Network_Query $this     The WP_Network_Query instance, passed by reference.
+		 *                                       or null to allow WP to run its normal queries.
+		 * @param WP_Network_Query $this         The WP_Network_Query instance, passed by reference.
 		 */
-		$network_ids = apply_filters_ref_array( 'networks_pre_query', array( $network_ids, &$this ) );
+		$network_data = apply_filters_ref_array( 'networks_pre_query', array( $network_data, &$this ) );
-		if ( null === $network_ids ) {
+		if ( null !== $network_data ) {
+			return $network_data;
-			// $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
+		}
-			$_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );
+		// $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
-			// Ignore the $fields argument as the queried result will be the same regardless.
+		$_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );
-			unset( $_args['fields'] );
+		// Ignore the $fields argument as the queried result will be the same regardless.
-			$key          = md5( serialize( $_args ) );
+		unset( $_args['fields'] );
-			$last_changed = wp_cache_get_last_changed( 'networks' );
+		$key          = md5( serialize( $_args ) );
-			$cache_key   = "get_network_ids:$key:$last_changed";
+		$last_changed = wp_cache_get_last_changed( 'networks' );
-			$cache_value = wp_cache_get( $cache_key, 'networks' );
+		$cache_key   = "get_network_ids:$key:$last_changed";
-			if ( false === $cache_value ) {
+		$cache_value = wp_cache_get( $cache_key, 'networks' );
-				$network_ids = $this->get_network_ids();
-				if ( $network_ids ) {
+		if ( false === $cache_value ) {
-					$this->set_found_networks();
+			$network_ids = $this->get_network_ids();
-				}
+			if ( $network_ids ) {
+				$this->set_found_networks();
-				$cache_value = array(
-					'network_ids'    => $network_ids,
-					'found_networks' => $this->found_networks,
-				);
-				wp_cache_add( $cache_key, $cache_value, 'networks' );
-			} else {
-				$network_ids          = $cache_value['network_ids'];
-				$this->found_networks = $cache_value['found_networks'];
 			}
+			$cache_value = array(
+				'network_ids'    => $network_ids,
+				'found_networks' => $this->found_networks,
+			);
+			wp_cache_add( $cache_key, $cache_value, 'networks' );
+		} else {
+			$network_ids          = $cache_value['network_ids'];
+			$this->found_networks = $cache_value['found_networks'];
 		}
 		if ( $this->found_networks && $this->query_vars['number'] ) {
 			$this->max_num_pages = ceil( $this->found_networks / $this->query_vars['number'] );
 		}
 			return intval( $network_ids );
 		}
 		$network_ids = array_map( 'intval', $network_ids );
-		if ( 'ids' == $this->query_vars['fields'] ) {
+		if ( 'ids' === $this->query_vars['fields'] ) {
 			$this->networks = $network_ids;
 			return $this->networks;
 		}
 		if ( $this->query_vars['update_network_cache'] ) {
 		}
 		// Fetch full network objects from the primed cache.
 		$_networks = array();
 		foreach ( $network_ids as $network_id ) {
-			if ( $_network = get_network( $network_id ) ) {
+			$_network = get_network( $network_id );
+			if ( $_network ) {
 				$_networks[] = $_network;
 			}
 		}
 		/**
 		 * @param WP_Network[]     $_networks An array of WP_Network objects.
 		 * @param WP_Network_Query $this      Current instance of WP_Network_Query (passed by reference).
 		 */
 		$_networks = apply_filters_ref_array( 'the_networks', array( $_networks, &$this ) );
-		// Convert to WP_Network instances
+		// Convert to WP_Network instances.
 		$this->networks = array_map( 'get_network', $_networks );
 		return $this->networks;
 	}
 	/**
 	 * Used internally to generate an SQL string for searching across multiple columns.
 	 *
 	 * @since 4.6.0
 	 *
-	 * @global wpdb  $wpdb WordPress database abstraction object.
+	 * @global wpdb $wpdb WordPress database abstraction object.
 	 *
 	 * @param string   $string  Search string.
 	 * @param string[] $columns Array of columns to search.
-	 *
 	 * @return string Search SQL.
 	 */
 	protected function get_search_sql( $string, $columns ) {
 		global $wpdb;
 			'domain',
 			'path',
 		);
 		$parsed = false;
-		if ( $orderby == 'network__in' ) {
+		if ( 'network__in' === $orderby ) {
 			$network__in = implode( ',', array_map( 'absint', $this->query_vars['network__in'] ) );
 			$parsed      = "FIELD( {$wpdb->site}.id, $network__in )";
-		} elseif ( $orderby == 'domain_length' || $orderby == 'path_length' ) {
+		} elseif ( 'domain_length' === $orderby || 'path_length' === $orderby ) {
 			$field  = substr( $orderby, 0, -7 );
 			$parsed = "CHAR_LENGTH($wpdb->site.$field)";
-		} elseif ( in_array( $orderby, $allowed_keys ) ) {
+		} elseif ( in_array( $orderby, $allowed_keys, true ) ) {
 			$parsed = "$wpdb->site.$orderby";
 		}
 		return $parsed;
 	}

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a