Changeset 49538 for trunk/src/wp-includes/class-wp-network-query.php

Timestamp:

11/08/2020 11:45:36 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Networks and Sites: Assign the array of site or network data returned from filters to the respective class property:

• The array of network data returned from the networks_pre_query filter is assigned to the networks property of the current WP_Network_Query instance.
• The array of site data returned from the sites_pre_query filter is assigned to the sites property of the current WP_Site_Query instance.

This avoids the performance overhead of calling WP_Network_Query::get_networks() or WP_Site_Query::get_sites() twice: first when creating the object instance, then to retrieve the filtered results.

This also makes the filters a bit more consistent with other similar filters, e.g. posts_pre_query, terms_pre_query, comments_pre_query, or users_pre_query.

Follow-up to [46086], [48990].

Props yakimun, spacedmonkey.
Fixes #51333.

File:

• trunk/src/wp-includes/class-wp-network-query.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-network-query.php

@@ -213 +213 @@
          * - Otherwise the filter should return an array of WP_Network objects.
          *
+         * Note that if the filter returns an array of network data, it will be assigned
+         * to the `networks` property of the current WP_Network_Query instance.
+         *
+         * Filtering functions that require pagination information are encouraged to set
+         * the `found_networks` and `max_num_pages` properties of the WP_Network_Query object,
+         * passed to the filter by reference. If WP_Network_Query does not perform a database
+         * query, it will not have enough information to generate these values itself.
+         *
          * @since 5.2.0
+         * @since 5.6.0 The returned array of network data is assigned to the `networks` property
+         *              of the current WP_Network_Query instance.
          *
          * @param array|int|null   $network_data Return an array of network data to short-circuit WP's network query,
@@ -223 +233 @@
 
         if ( null !== $network_data ) {
+            if ( is_array( $network_data ) && ! $this->query_vars['count'] ) {
+                $this->networks = $network_data;
+            }
+
             return $network_data;
         }