Make WordPress Core

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

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.

1 edited


  • trunk/src/wp-includes/class-wp-site-query.php

    r49108 r49538  
    304304         * - Otherwise the filter should return an array of WP_Site objects.
    305305         *
     306         * Note that if the filter returns an array of site data, it will be assigned
     307         * to the `sites` property of the current WP_Site_Query instance.
     308         *
     309         * Filtering functions that require pagination information are encouraged to set
     310         * the `found_sites` and `max_num_pages` properties of the WP_Site_Query object,
     311         * passed to the filter by reference. If WP_Site_Query does not perform a database
     312         * query, it will not have enough information to generate these values itself.
     313         *
    306314         * @since 5.2.0
     315         * @since 5.6.0 The returned array of site data is assigned to the `sites` property
     316         *              of the current WP_Site_Query instance.
    307317         *
    308318         * @param array|int|null $site_data Return an array of site data to short-circuit WP's site query,
    315325        if ( null !== $site_data ) {
     326            if ( is_array( $site_data ) && ! $this->query_vars['count'] ) {
     327                $this->sites = $site_data;
     328            }
    316330            return $site_data;
    317331        }
Note: See TracChangeset for help on using the changeset viewer.