Merge pull request #649 from Automattic/switch_to_blog_messaging

RestrictedFunctionsSniff: Change default message of switch_to_blog()

Author: rebeccahum

WordPress-VIP-Go/ruleset-test.php

@@ -331,9 +331,6 @@
 		196 => [
 			'Stylesheets should be registered/enqueued via `wp_enqueue_style`. This can improve the site\'s performance due to styles concatenation.',
 		],
-		269 => [
-			'Switch to blog may not work as expected since it only changes the database context for the blog and does not load the plugins or theme of that site. This means that filters or hooks that the blog you are switching to uses will not run.',
-		],
 	],
 ];
 

WordPress-VIP-Go/ruleset.xml

@@ -241,9 +241,7 @@
 		<severity>1</severity>
 	</rule>
 	<rule ref="WordPressVIPMinimum.Functions.RestrictedFunctions.switch_to_blog_switch_to_blog">
-		<type>warning</type>
 		<severity>3</severity>
-		<message>Switch to blog may not work as expected since it only changes the database context for the blog and does not load the plugins or theme of that site. This means that filters or hooks that the blog you are switching to uses will not run.</message>
 	</rule>
 	<rule ref="WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn">
 		<severity>3</severity>

WordPressVIPMinimum/Sniffs/Functions/RestrictedFunctionsSniff.php

@@ -83,8 +83,8 @@ public function getGroups() {
 			],
 			// @link https://docs.wpvip.com/technical-references/code-review/vip-notices/#h-switch_to_blog
 			'switch_to_blog' => [
-				'type'      => 'error',
-				'message'   => '%s() is not something you should ever need to do in a VIP theme context. Instead use an API (XML-RPC, REST) to interact with other sites if needed.',
+				'type'      => 'warning',
+				'message'   => '%s() may not work as expected since it only changes the database context for the blog and does not load the plugins or theme of that site. Filters or hooks on the blog you are switching to will not run.',
 				'functions' => [
 					'switch_to_blog',
 				],

WordPressVIPMinimum/Tests/Functions/RestrictedFunctionsUnitTest.inc

@@ -53,7 +53,7 @@ db_delta(); // Ok - similarly-named function to dbDelta().
 dbDelta(); // Error.
 
 switch_blog(); // Ok - similarly-named function to switch_to_blog().
-switch_to_blog( $blogid ); // Error.
+switch_to_blog( $blogid ); // Warning.
 
 wpcom_vip_get_page_by_title(); // Ok - VIP recommended version of get_page_by_title().
 get_page_by_title( $page_title ); // Error.

WordPressVIPMinimum/Tests/Functions/RestrictedFunctionsUnitTest.php

@@ -38,7 +38,6 @@ public function getErrorList() {
 			46  => 1,
 			50  => 1,
 			53  => 1,
-			56  => 1,
 			59  => 1,
 			62  => 1,
 			75  => 1,
@@ -114,6 +113,7 @@ public function getErrorList() {
 	 */
 	public function getWarningList() {
 		return [
+			56  => 1,
 			110 => 1,
 			111 => 1,
 			114 => 1,

WordPressVIPMinimum/ruleset-test.inc

@@ -321,7 +321,7 @@ flush_rewrite_rules(); // Error.
 $wp_rewrite->flush_rules(); // Error.
 attachment_url_to_postid( $url ); // Error.
 dbDelta(); // Error.
-switch_to_blog( $blogid ); // Error.
+switch_to_blog( $blogid ); // Warning.
 get_page_by_title( $page_title ); // Error.
 url_to_postid( $url ); // Error.
 \add_role(); // Error.

WordPressVIPMinimum/ruleset-test.php

@@ -93,7 +93,6 @@
 		321 => 1,
 		322 => 1,
 		323 => 1,
-		324 => 1,
 		325 => 1,
 		326 => 1,
 		327 => 1,
@@ -255,6 +254,7 @@
 		288 => 1,
 		293 => 1,
 		294 => 1,
+		324 => 1,
 		396 => 1,
 		397 => 1,
 		398 => 1,