switch_to_blog() doesn't fail on validation

[markoheijnen]

Currently you can pass in a non existing blog id. It will always return true since there is no validation in switch_to_blog(). Even if the PHPDocs says it does do that.

The best place to add a check is wpdb::set_blog_id() but I'm not sure if we want to add an extra database on the init of a site.

[nacin]

Replying to markoheijnen:

The best place to add a check is wpdb::set_blog_id() but I'm not sure if we want to add an extra database on the init of a site.

We don't. This seems like a wontfix.

[markoheijnen]

So that would mean fixing the PHPDocs.

[jeremyfelt]

Related: #25293

[jeremyfelt]

25328.diff​ modifies docs to show that switch_to_blog() always returns true.

[jeremyfelt]

Doc change in 25328.diff​ still applies cleanly to trunk.

[DrewAPicture]

In 27347:

Fix the return description for switch_to_blog() to reflect that it always returns true.

Props jeremyfelt.
Fixes #25328.

[nacin]

Devil's advocate for [27347]: The docs weren't actually wrong — there was just no validation for which we would return false. We may want to add a falsely return value later. What do we think about making it say "always returns true. Could return false on failure in the future."

[DrewAPicture]

Replying to nacin:

Devil's advocate for [27347]: The docs weren't actually wrong — there was just no validation for which we would return false. We may want to add a falsely return value later. What do we think about making it say "always returns true. Could return false on failure in the future."

I'm not a big fan of conjecture when it comes to documentation — it either does or it doesn't. That said, I could get behind a @todo specifying a need for future clarification.