Prevent unneeded blog switching in multisite env.

[Levdbas]

To get some further experience with PRs I wanted to tackle an older issue.

Related:

• \Timber\Site\__construct breaks image srcset #1180

Issue

switch_to_blog() was used when not needed in multisite environments, resulting in unneeded globals being set.

Solution

Only use switch_to_blog() when the ID is different from the current id blog id. While at it, I changed some internal variables to reflect the new internal working and updated the docblock as well. I also added a fallback when get_blog_details() returns null instead of a site object.

Impact

Less globals set in the form of $GLOBALS['_wp_switched_stack'] and $GLOBALS['switched']

Testing

Current tests are covering it.

[coveralls]

coverage: 88.422% (-0.3%) from 88.676% when pulling 3e45f8a on 1180-timbersite__construct-breaks-image-srcset into 129b9c6 on 2.x.

[gchtr]

Good catch!

I only found some issues with strict types, otherwise this looks good to me.

[gchtr]

@Levdbas I’ve marked this as 2.x future, because it’s not essential to include this in the Release Candidate for Timber 2.0 ;).

[Levdbas]

@Levdbas I’ve marked this as 2.x future, because it’s not essential to include this in the Release Candidate for Timber 2.0 ;).

No problem! I think I managed to fix the PR though. Prior to this PR Timber was always switching to a blog, no matter what. After my initial changes Timber was still always changing because of the strict checking and without transforming the $blog_identifier in an INT first, still resulting in always switching in these tests and thus passing the tests.

After applying your suggestions, it finally passed the strict testing and resulting in not switching for the first time but resulting in testing errors.

What I did to make the tests work again:

Add restore_current_blog(); after each switch blog function, just like it is recommended by WordPress. Adding these on rule 149, 151, 153 was needed in the end to fix the test.

I think this is because self::createSubDomainSite switches to a particular blog as well. Since we ended up preventing unnecessary switching, the get_post() call was running on the wrong website at

timber/tests/test-timber-multisite.php

Line 192 in 3e45f8a

$current_site_all_posts = get_posts();

resulting in a wrong test result.

So by setting the restore_current_blog(); we made sure each time we make sure that the starting blog is correct for making the query.

Let me know what your thoughts.