Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore current blog when the_post triggers outside the loop. #2283

Merged
merged 4 commits into from
Aug 2, 2021
Merged

Restore current blog when the_post triggers outside the loop. #2283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a75a4e
Restore current blog when the_post triggers outside the loop.
gonzomir Mar 20, 2021
a442546
Fix post indexable tests, test the new behaviour of maybe_switch_to_b…
gonzomir Mar 22, 2021
0ccc5ff
Add default value to `maybe_switch_to_blog` + Docs
felipeelia Aug 1, 2021
e625028
Merge branch 'develop' into fix/issue-2121
felipeelia Aug 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file modified bin/install-wp-tests.sh
100644 → 100755
View file
Open in desktop
Empty file.
27 changes: 21 additions & 6 deletions includes/classes/Indexable/Post/QueryIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public function __construct() {
add_action( 'loop_end', array( $this, 'maybe_restore_blog' ), 10, 1 );

// Properly switch to blog if necessary
add_action( 'the_post', array( $this, 'maybe_switch_to_blog' ), 10, 1 );
add_action( 'the_post', array( $this, 'maybe_switch_to_blog' ), 10, 2 );

// Sets the correct value for found_posts
add_filter( 'found_posts', array( $this, 'found_posts' ), 10, 2 );
Expand Down Expand Up @@ -131,12 +131,21 @@ public function get_switched() {
}

/**
* Switch to the correct site if the post site id is different than the actual one
* Switch to the correct site if the post site id is different than the actual one.
*
* @param WP_Post $post Post object
* Note: This function can bring a performance penalty in multisites with a high number of sites.
*
* @param WP_Post $post Post object
* @param WP_Query $query WP_Query instance. If null, the global query will be used.
* @since 0.9
* @since 3.6.2 `$query` parameter added.
*/
public function maybe_switch_to_blog( $post ) {
public function maybe_switch_to_blog( $post, $query = null ) {
global $wp_query;
if ( ! $query ) {
$query = $wp_query;
}

if ( ! is_multisite() ) {
// @codeCoverageIgnoreStart
return;
Expand All @@ -154,9 +163,15 @@ public function maybe_switch_to_blog( $post ) {

$this->switched = $post->site_id;

remove_action( 'the_post', array( $this, 'maybe_switch_to_blog' ), 10, 1 );
remove_action( 'the_post', array( $this, 'maybe_switch_to_blog' ), 10, 2 );
setup_postdata( $post );
add_action( 'the_post', array( $this, 'maybe_switch_to_blog' ), 10, 1 );
add_action( 'the_post', array( $this, 'maybe_switch_to_blog' ), 10, 2 );

if ( $this->switched && ! $query->in_the_loop ) {
restore_current_blog();

$this->switched = false;
}
}

}
Expand Down
12 changes: 10 additions & 2 deletions tests/php/indexables/TestPost.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5983,14 +5983,22 @@ public function testMaybeSwitchToBlog() {
// test the function. Try accessing the 2nd post from the 1st blog.
$query_integration = new \ElasticPress\Indexable\Post\QueryIntegration();

// This should not switch to the 2nd site because the query is not in the loop.
$query_integration->maybe_switch_to_blog( $blog_2_post, $query );

$this->assertFalse( $query_integration->get_switched() );

// To switch sites the query must be in the loop.
$query->in_the_loop = true;

// This should switch to the 2nd site.
$query_integration->maybe_switch_to_blog( $blog_2_post );
$query_integration->maybe_switch_to_blog( $blog_2_post, $query );

$this->assertSame( $blog_2_post->site_id, $query_integration->get_switched() );

// Now we're in "switched" mode, try getting the post from the
// 1st site, should switch back.
$query_integration->maybe_switch_to_blog( $blog_1_post );
$query_integration->maybe_switch_to_blog( $blog_1_post, $query );

$this->assertSame( $blog_1_post->site_id, $query_integration->get_switched() );

Expand Down