Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-22 21:04:57 +02:00
Code Issues Projects Releases Wiki Activity

Multisite: add new sites_pre_query and networks_pre_query filters to short circuit WP_Site_Query and WP_Network_Query queries.

Browse Source 
Similar to the `posts_pre_query` filter for WP_Query added in #36687. These filters lets you short circuit the queries to return your own results.

Add a new filter `sites_pre_query` - which returns null by default. Return a non-null value to bypass WordPress's default `get_sites` queries.

Developers should note that filtering functions that require pagination information are encouraged to set the `found_sites` property of the `WP_Site_Query` object, passed to the filter by reference. If `WP_Site_Query` does not perform a database query, it will not have enough information to generate these values itself.

Add a new filter `networks_pre_query` - which returns null by default. Return a non-null value to bypass WordPress's default `get_networks` queries.

Developers should note that filtering functions that require pagination information are encouraged to set the `found_networks` property 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.

Props spacedmonkey.
Fixes #45749.


Built from https://develop.svn.wordpress.org/trunk@44983


git-svn-id: http://core.svn.wordpress.org/trunk@44814 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Adam Silverstein 2019-03-22 17:26:51 +00:00
parent bd83b90f1e
commit cd67264bb2
3 changed files with 81 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
wp-includes/class-wp-network-query.php
View File

@ -197,32 +197,51 @@ class WP_Network_Query {
*/
do_action_ref_array( 'pre_get_networks', array( &$this ) );
// $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 ) );
$network_ids = null;
// Ignore the $fields argument as the queried result will be the same regardless.
unset( $_args['fields'] );
/**
* Filter the sites array before the query takes place.
*
* Return a non-null value to bypass WordPress's default site queries.
*
*
* @since 5.2.0
*
* @param array|null $site_ids Return an array of site data to short-circuit WP's site query,
* 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 ) );
$key = md5( serialize( $_args ) );
$last_changed = wp_cache_get_last_changed( 'networks' );
if ( null === $network_ids ) {
$cache_key = "get_network_ids:$key:$last_changed";
$cache_value = wp_cache_get( $cache_key, 'networks' );
// $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 ) );
if ( false === $cache_value ) {
$network_ids = $this->get_network_ids();
if ( $network_ids ) {
$this->set_found_networks();
// Ignore the $fields argument as the queried result will be the same regardless.
unset( $_args['fields'] );
$key = md5( serialize( $_args ) );
$last_changed = wp_cache_get_last_changed( 'networks' );
$cache_key = "get_network_ids:$key:$last_changed";
$cache_value = wp_cache_get( $cache_key, 'networks' );
if ( false === $cache_value ) {
$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'] ) {

61
wp-includes/class-wp-site-query.php
View File

@ -288,32 +288,51 @@ class WP_Site_Query {
$this->meta_query_clauses = $this->meta_query->get_sql( 'blog', $wpdb->blogs, 'blog_id', $this );
}
// $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 ) );
$site_ids = null;
// Ignore the $fields argument as the queried result will be the same regardless.
unset( $_args['fields'] );
/**
* Filter the sites array before the query takes place.
*
* Return a non-null value to bypass WordPress's default site queries.
*
*
* @since 5.2.0
*
* @param array|null $site_ids Return an array of site data to short-circuit WP's site query,
* or null to allow WP to run its normal queries.
* @param WP_Site_Query $this The WP_Site_Query instance, passed by reference.
*/
$site_ids = apply_filters_ref_array( 'sites_pre_query', array( $site_ids, &$this ) );
$key = md5( serialize( $_args ) );
$last_changed = wp_cache_get_last_changed( 'sites' );
if ( null === $site_ids ) {
$cache_key = "get_sites:$key:$last_changed";
$cache_value = wp_cache_get( $cache_key, 'sites' );
// $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 ) );
if ( false === $cache_value ) {
$site_ids = $this->get_site_ids();
if ( $site_ids ) {
$this->set_found_sites();
// Ignore the $fields argument as the queried result will be the same regardless.
unset( $_args['fields'] );
$key = md5( serialize( $_args ) );
$last_changed = wp_cache_get_last_changed( 'sites' );
$cache_key = "get_sites:$key:$last_changed";
$cache_value = wp_cache_get( $cache_key, 'sites' );
if ( false === $cache_value ) {
$site_ids = $this->get_site_ids();
if ( $site_ids ) {
$this->set_found_sites();
}
$cache_value = array(
'site_ids' => $site_ids,
'found_sites' => $this->found_sites,
);
wp_cache_add( $cache_key, $cache_value, 'sites' );
} else {
$site_ids = $cache_value['site_ids'];
$this->found_sites = $cache_value['found_sites'];
}
$cache_value = array(
'site_ids' => $site_ids,
'found_sites' => $this->found_sites,
);
wp_cache_add( $cache_key, $cache_value, 'sites' );
} else {
$site_ids = $cache_value['site_ids'];
$this->found_sites = $cache_value['found_sites'];
}
if ( $this->found_sites && $this->query_vars['number'] ) {

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.2-alpha-44982';
$wp_version = '5.2-alpha-44983';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.