Merge pull request #169 from Automattic/updated-messaging

trepmal · web-flow · commit 67e46757d677 · 2018-03-28T12:16:58.000-07:00
use backticks around code elements; fix a few typos
diff --git a/WordPressVIPMinimum/Sniffs/Actions/PreGetPostsSniff.php b/WordPressVIPMinimum/Sniffs/Actions/PreGetPostsSniff.php
@@ -248,10 +248,10 @@ private function processFunctionBody( $stackPtr, $variableName ) {
 				}
 			} elseif ( $this->isInsideIfConditonal( $wpQueryVarUsed ) ) {
 				if ( ! $this->isParentConditionalCheckingMainQuery( $wpQueryVarUsed ) ) {
-					$this->_phpcsFile->addWarning( 'Main WP_Query is being modified without $query->is_main_query() check. Needs manual inspection.', $wpQueryVarUsed, 'PreGetPosts' );
+					$this->_phpcsFile->addWarning( 'Main WP_Query is being modified without `$query->is_main_query()` check. Needs manual inspection.', $wpQueryVarUsed, 'PreGetPosts' );
 				}
 			} elseif ( $this->isWPQueryMethodCall( $wpQueryVarUsed, 'set' ) ) {
-				$this->_phpcsFile->addWarning( 'Main WP_Query is being modified without $query->is_main_query() check. Needs manual inspection.', $wpQueryVarUsed, 'PreGetPosts' );
+				$this->_phpcsFile->addWarning( 'Main WP_Query is being modified without `$query->is_main_query()` check. Needs manual inspection.', $wpQueryVarUsed, 'PreGetPosts' );
 			}
 			$wpQueryVarUsed = $this->_phpcsFile->findNext(
 				array( T_VARIABLE ), // types.
diff --git a/WordPressVIPMinimum/Sniffs/Cache/BatcacheWhitelistedParamsSniff.php b/WordPressVIPMinimum/Sniffs/Cache/BatcacheWhitelistedParamsSniff.php
@@ -106,7 +106,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		$variable_name = substr( $variable_name, 1, -1 );
 
 		if ( true === in_array( $variable_name, $this->whitelistes_batcache_params, true ) ) {
-			$phpcsFile->addWarning( sprintf( 'Batcache whitelisted GET param, %s, found. Batcache whitelisted parameters get stripped and are not available in PHP.', $variable_name ), $stackPtr, 'strippedGetParam' );
+			$phpcsFile->addWarning( sprintf( 'Batcache whitelisted GET param, `%s`, found. Batcache whitelisted parameters get stripped and are not available in PHP.', $variable_name ), $stackPtr, 'strippedGetParam' );
 			return;
 		}
 	}//end process()
diff --git a/WordPressVIPMinimum/Sniffs/Cache/CacheValueOverrideSniff.php b/WordPressVIPMinimum/Sniffs/Cache/CacheValueOverrideSniff.php
@@ -97,7 +97,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		$valueAfterEqualSign = $phpcsFile->findNext( Tokens::$emptyTokens, ( $rightAfterNextVariableOccurence + 1 ), null, true, null, true );
 
 		if ( T_FALSE === $tokens[ $valueAfterEqualSign ]['code'] ) {
-			$phpcsFile->addError( sprintf( 'Obtained cached value in %s is being overriden. Disabling caching?', $variableName ), $nextVariableOccurrence, 'CacheValueOverride' );
+			$phpcsFile->addError( sprintf( 'Obtained cached value in `%s` is being overriden. Disabling caching?', $variableName ), $nextVariableOccurrence, 'CacheValueOverride' );
 		}
 
 	} //end Process()
diff --git a/WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php b/WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php
@@ -303,7 +303,7 @@ private function addError( $parentClassName, $methodName, $currentMethodSignatur
 
 		$parentSignature = sprintf( '%s::%s(%s)', $parentClassName, $methodName, implode( ', ', $this->generateParamList( $parentMethodSignature ) ) );
 
-		$phpcsFile->addError( sprintf( 'Declaration of %s should be compatible with %s', $currentSignature, $parentSignature ), $stackPtr, 'DeclarationCompatibility' );
+		$phpcsFile->addError( sprintf( 'Declaration of `%s` should be compatible with `%s`', $currentSignature, $parentSignature ), $stackPtr, 'DeclarationCompatibility' );
 	}//end addError()
 
 	/**
diff --git a/WordPressVIPMinimum/Sniffs/Constants/ConstantRestrictionsSniff.php b/WordPressVIPMinimum/Sniffs/Constants/ConstantRestrictionsSniff.php
@@ -73,7 +73,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		}
 
 		if ( T_STRING === $tokens[ $stackPtr ]['code'] && true === in_array( $constantName, $this->restrictedConstantNames, true ) ) {
-			$phpcsFile->addWarning( sprintf( 'Code is touching the %s constant. Make sure it\'s used appropriately.', $constantName ), $stackPtr, 'ConstantRestrictions' );
+			$phpcsFile->addWarning( sprintf( 'Code is touching the `%s` constant. Make sure it\'s used appropriately.', $constantName ), $stackPtr, 'ConstantRestrictions' );
 			return;
 		}
 
@@ -101,9 +101,9 @@ public function process( File $phpcsFile, $stackPtr ) {
 
 		if ( true === in_array( $tokens[ $previous ]['code'], Tokens::$functionNameTokens, true ) ) {
 			if ( 'define' === $tokens[ $previous ]['content'] ) {
-				$phpcsFile->addError( sprintf( 'The definition of %s constant is prohibited. Please use a different name.', $constantName ), $previous, 'ConstantRestrictions' );
+				$phpcsFile->addError( sprintf( 'The definition of `%s` constant is prohibited. Please use a different name.', $constantName ), $previous, 'ConstantRestrictions' );
 			} elseif ( true === in_array( $constantName, $this->restrictedConstantNames, true ) ) {
-				$phpcsFile->addWarning( sprintf( 'Code is touching the %s constant. Make sure it\'s used appropriately.', $constantName ), $previous, 'ConstantRestrictions' );
+				$phpcsFile->addWarning( sprintf( 'Code is touching the `%s` constant. Make sure it\'s used appropriately.', $constantName ), $previous, 'ConstantRestrictions' );
 			}
 		}
 	}
diff --git a/WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php b/WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php
@@ -61,7 +61,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		$nextToken = $phpcsFile->findNext( Tokens::$emptyTokens, ( $nextToken + 1 ), null, true, null, true );
 
 		if ( T_CONSTANT_ENCAPSED_STRING !== $tokens[ $nextToken ]['code'] ) {
-			$phpcsFile->addError( sprintf( 'Constant name, as a string, should be used along with %s().', $tokens[ $stackPtr ]['content'] ), $nextToken, 'NotCheckingConstantName' );
+			$phpcsFile->addError( sprintf( 'Constant name, as a string, should be used along with `%s()`.', $tokens[ $stackPtr ]['content'] ), $nextToken, 'NotCheckingConstantName' );
 			return;
 		}
 
diff --git a/WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php b/WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php
@@ -101,7 +101,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		}
 
 		if ( T_VARIABLE === $tokens[ $nextToken ]['code'] ) {
-			$phpcsFile->addWarning( sprintf( 'File inclusion using variable (%s). Probably needs manual inspection.', $tokens[ $nextToken ]['content'] ), $nextToken, 'IncludingFile' );
+			$phpcsFile->addWarning( sprintf( 'File inclusion using variable (`%s`). Probably needs manual inspection.', $tokens[ $nextToken ]['content'] ), $nextToken, 'IncludingFile' );
 			return;
 		}
 
@@ -119,18 +119,18 @@ public function process( File $phpcsFile, $stackPtr ) {
 
 			if ( true === in_array( $tokens[ $nextToken ]['content'], array_keys( $this->restrictedConstants ), true ) ) {
 				// The construct is using one of the restricted constants.
-				$phpcsFile->addError( sprintf( '%s constant might not be defined or available. Use %s instead.', $tokens[ $nextToken ]['content'], $this->restrictedConstants[ $tokens[ $nextToken ]['content'] ] ), $nextToken );
+				$phpcsFile->addError( sprintf( '`%s` constant might not be defined or available. Use `%s()` instead.', $tokens[ $nextToken ]['content'], $this->restrictedConstants[ $tokens[ $nextToken ]['content'] ] ), $nextToken );
 				return;
 			}
 
 			if ( 1 === preg_match( '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $tokens[ $nextToken ]['content'] ) ) {
 				// The construct is using custom constant, which needs manula inspection.
-				$phpcsFile->addWarning( sprintf( 'File inclusion using custom constant (%s). Probably needs manual inspection.', $tokens[ $nextToken ]['content'] ), $nextToken, 'IncludingFile' );
+				$phpcsFile->addWarning( sprintf( 'File inclusion using custom constant (`%s`). Probably needs manual inspection.', $tokens[ $nextToken ]['content'] ), $nextToken, 'IncludingFile' );
 				return;
 			}
 
 			if ( 0 === strpos( $tokens[ $nextToken ]['content'], '$' ) ) {
-				$phpcsFile->addWarning( sprintf( 'File inclusion using variable (%s). Probably needs manual inspection.', $tokens[ $nextToken ]['content'] ), $nextToken, 'IncludingFile' );
+				$phpcsFile->addWarning( sprintf( 'File inclusion using variable (`%s`). Probably needs manual inspection.', $tokens[ $nextToken ]['content'] ), $nextToken, 'IncludingFile' );
 				return;
 			}
 
@@ -141,14 +141,14 @@ public function process( File $phpcsFile, $stackPtr ) {
 
 			$nextNextToken = $phpcsFile->findNext( Tokens::$emptyTokens, ( $nextToken + 1 ), null, true, null, true );
 			if ( T_OPEN_PARENTHESIS === $tokens[ $nextNextToken ]['code'] ) {
-				$phpcsFile->addWarning( sprintf( 'File inclusion using custom function ( %s() ). Probably needs manual inspection.', $tokens[ $nextToken ]['content'] ), $nextToken, 'IncludingFile' );
+				$phpcsFile->addWarning( sprintf( 'File inclusion using custom function ( `%s()` ). Probably needs manual inspection.', $tokens[ $nextToken ]['content'] ), $nextToken, 'IncludingFile' );
 				return;
 			}
 
-			$phpcsFile->addError( 'Absolute include path must be used. Use get_template_directory, get_stylesheet_directory or plugin_dir_path.', $nextToken, 'IncludingFile' );
+			$phpcsFile->addError( 'Absolute include path must be used. Use `get_template_directory()`, `get_stylesheet_directory()` or `plugin_dir_path()`.', $nextToken, 'IncludingFile' );
 			return;
 		} else {
-			$phpcsFile->addError( 'Absolute include path must be used. Use get_template_directory, get_stylesheet_directory or plugin_dir_path.', $nextToken, 'IncludingFile' );
+			$phpcsFile->addError( 'Absolute include path must be used. Use `get_template_directory()`, `get_stylesheet_directory()` or `plugin_dir_path()`.', $nextToken, 'IncludingFile' );
 			return;
 		}// End if().
 
diff --git a/WordPressVIPMinimum/Sniffs/Functions/CheckReturnValueSniff.php b/WordPressVIPMinimum/Sniffs/Functions/CheckReturnValueSniff.php
@@ -190,7 +190,7 @@ public function findDirectFunctionCalls( $stackPtr ) {
 		$next      = $phpcsFile->findNext( Tokens::$functionNameTokens, $startNext, $closeBracket, false, null, true );
 		while ( $next ) {
 			if ( true === in_array( $tokens[ $next ]['content'], $this->catch[ $functionName ], true ) ) {
-				$phpcsFile->addError( sprintf( "%s's return type must be checked before calling %s using that value", $tokens[ $next ]['content'], $functionName ), $next, 'CheckReturnValue' );
+				$phpcsFile->addError( sprintf( "`%s`'s return type must be checked before calling `%s` using that value", $tokens[ $next ]['content'], $functionName ), $next, 'CheckReturnValue' );
 			}
 			$next = $phpcsFile->findNext( Tokens::$functionNameTokens, ( $next + 1 ), $closeBracket, false, null, true );
 		}
@@ -299,7 +299,7 @@ public function findNonCheckedVariables( $stackPtr ) {
 			if ( true === in_array( $tokens[ $nextFunctionCallWithVariable ]['code'], array_merge( Tokens::$functionNameTokens, $notFunctionsCallee ), true )
 				&& $tokens[ $nextFunctionCallWithVariable ]['content'] === $callee
 			) {
-				$phpcsFile->addError( sprintf( 'Type of %s must be checked before calling %s using that variable', $variableName, $callee ), $nextFunctionCallWithVariable, 'CheckReturnValue' );
+				$phpcsFile->addError( sprintf( 'Type of `%s` must be checked before calling `%s()` using that variable', $variableName, $callee ), $nextFunctionCallWithVariable, 'CheckReturnValue' );
 				return;
 			}
 
@@ -308,7 +308,7 @@ public function findNonCheckedVariables( $stackPtr ) {
 			if ( true === in_array( $tokens[ $next ]['code'], Tokens::$functionNameTokens, true )
 				&& $tokens[ $next ]['content'] === $callee
 			) {
-				$phpcsFile->addError( sprintf( 'Type of %s must be checked before calling %s using that variable', $variableName, $callee ), $next, 'CheckReturnValue' );
+				$phpcsFile->addError( sprintf( 'Type of `%s` must be checked before calling `%s()` using that variable', $variableName, $callee ), $next, 'CheckReturnValue' );
 				return;
 			}
 		}
diff --git a/WordPressVIPMinimum/Sniffs/JS/HTMLExecutingFunctionsSniff.php b/WordPressVIPMinimum/Sniffs/JS/HTMLExecutingFunctionsSniff.php
@@ -81,7 +81,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		while ( $nextToken < $parenthesis_closer ) {
 			$nextToken = $phpcsFile->findNext( Tokens::$emptyTokens, ( $nextToken + 1 ), null, true, null, true );
 			if ( T_STRING === $tokens[ $nextToken ]['code'] ) {
-				$phpcsFile->addWarning( sprintf( 'Any HTML passed to %s gets executed. Make sure it\'s properly escaped.', $tokens[ $stackPtr ]['content'] ), $stackPtr, $tokens[ $stackPtr ]['content'] );
+				$phpcsFile->addWarning( sprintf( 'Any HTML passed to `%s` gets executed. Make sure it\'s properly escaped.', $tokens[ $stackPtr ]['content'] ), $stackPtr, $tokens[ $stackPtr ]['content'] );
 				return;
 			}
 		}
diff --git a/WordPressVIPMinimum/Sniffs/JS/InnerHTMLSniff.php b/WordPressVIPMinimum/Sniffs/JS/InnerHTMLSniff.php
@@ -84,7 +84,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		}
 
 		if ( true === $foundVariable ) {
-			$phpcsFile->addWarning( sprintf( 'Any HTML passed to %s gets executed. Consider using .textContent or make sure that used variables are properly escaped.', $tokens[ $stackPtr ]['content'] ), $stackPtr, $tokens[ $stackPtr ]['content'] );
+			$phpcsFile->addWarning( sprintf( 'Any HTML passed to `%s` gets executed. Consider using `.textContent` or make sure that used variables are properly escaped.', $tokens[ $stackPtr ]['content'] ), $stackPtr, $tokens[ $stackPtr ]['content'] );
 		}
 
 	}//end process()
diff --git a/WordPressVIPMinimum/Sniffs/VIP/ErrorControlSniff.php b/WordPressVIPMinimum/Sniffs/VIP/ErrorControlSniff.php
@@ -40,7 +40,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 
 		$tokens = $phpcsFile->getTokens();
 
-		$phpcsFile->addError( sprintf( 'The code shouldn\'t use error control operators (%s). The call should be wrapped in appropriate checks.', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'ErrorControl' );
+		$phpcsFile->addError( sprintf( 'The code shouldn\'t use error control operators (`%s`). The call should be wrapped in appropriate checks.', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'ErrorControl' );
 	}
 
 }
diff --git a/WordPressVIPMinimum/Sniffs/VIP/EscapingVoidReturnFunctionsSniff.php b/WordPressVIPMinimum/Sniffs/VIP/EscapingVoidReturnFunctionsSniff.php
@@ -61,7 +61,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		}
 
 		if ( 0 === strpos( $tokens[ $next_token ]['content'], '_e' ) ) {
-			$phpcsFile->addError( sprintf( 'Attempting to escape %s() which is printing it\'s output.', $tokens[ $next_token ]['content'] ), $stackPtr, 'escapingVoidReturningFunction' );
+			$phpcsFile->addError( sprintf( 'Attempting to escape `%s()` which is printing its output.', $tokens[ $next_token ]['content'] ), $stackPtr, 'escapingVoidReturningFunction' );
 			return;
 		}
 	}
diff --git a/WordPressVIPMinimum/Sniffs/VIP/ExitAfterRedirectSniff.php b/WordPressVIPMinimum/Sniffs/VIP/ExitAfterRedirectSniff.php
@@ -59,10 +59,10 @@ public function process( File $phpcsFile, $stackPtr ) {
 				}
 			}
 			if ( false === $is_exit_in_scope ) {
-				$phpcsFile->addError( sprintf( '%s should almost always be followed by a call to exit;', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'NoExitInConditional' );
+				$phpcsFile->addError( sprintf( '`%s()` should almost always be followed by a call to `exit;`', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'NoExitInConditional' );
 			}
 		} elseif ( T_EXIT !== $tokens[ $next_token ]['code'] ) {
-			$phpcsFile->addError( sprintf( '%s should almost always be followed by a call to exit;', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'NoExit' );
+			$phpcsFile->addError( sprintf( '`%s()` should almost always be followed by a call to `exit;`', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'NoExit' );
 		}
 	}//end process()
 }
diff --git a/WordPressVIPMinimum/Sniffs/VIP/FlushRewriteRulesSniff.php b/WordPressVIPMinimum/Sniffs/VIP/FlushRewriteRulesSniff.php
@@ -89,7 +89,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 			return;
 		}
 
-		$phpcsFile->addError( sprintf( '%s should not be used in any normal circumstances in the theme code.', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'FlushRewriteRules' );
+		$phpcsFile->addError( sprintf( '`%s()` should not be used in any normal circumstances in the theme code.', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'FlushRewriteRules' );
 	}
 
 }
diff --git a/WordPressVIPMinimum/Sniffs/VIP/ProperEscapingFunctionSniff.php b/WordPressVIPMinimum/Sniffs/VIP/ProperEscapingFunctionSniff.php
@@ -84,11 +84,11 @@ public function process( File $phpcsFile, $stackPtr ) {
 		}
 
 		if ( 'esc_url' !== $function_name && $this->is_href_or_src( $tokens[ $html ]['content'] ) ) {
-			$phpcsFile->addError( sprintf( 'Wrong escaping function. href and src attributes should be escaped by esc_url, not by %s', $function_name ), $stackPtr, 'hrefSrcEscUrl' );
+			$phpcsFile->addError( sprintf( 'Wrong escaping function. href and src attributes should be escaped by `esc_url()`, not by `%s()`', $function_name ), $stackPtr, 'hrefSrcEscUrl' );
 			return;
 		}
 		if ( 'esc_html' === $function_name && $this->is_html_attr( $tokens[ $html ]['content'] ) ) {
-			$phpcsFile->addError( sprintf( 'Wrong escaping function. HTML attributes should be escaped by esc_attr, not by %s', $function_name ), $stackPtr, 'htmlAttrNotByEscHTML' );
+			$phpcsFile->addError( sprintf( 'Wrong escaping function. HTML attributes should be escaped by `esc_attr()`, not by `%s()`', $function_name ), $stackPtr, 'htmlAttrNotByEscHTML' );
 			return;
 		}
 
diff --git a/WordPressVIPMinimum/Sniffs/VIP/RestrictedFunctionsSniff.php b/WordPressVIPMinimum/Sniffs/VIP/RestrictedFunctionsSniff.php
@@ -26,45 +26,45 @@ public function getGroups() {
 		$new_groups = array(
 			'wp_cache_get_multi'       => array(
 				'type'      => 'error',
-				'message'   => '%s is not supported on the WordPress.com VIP platform.',
+				'message'   => '`%s` is not supported on the WordPress.com VIP platform.',
 				'functions' => array( 'wp_cache_get_multi' ),
 			),
 			'get_super_admins'         => array(
 				'type'      => 'error',
-				'message'   => '%s is prohibited on the WordPress.com VIP platform',
+				'message'   => '`%s` is prohibited on the WordPress.com VIP platform',
 				'functions' => array( 'get_super_admins' ),
 			),
 			'internal'                 => array(
 				'type'      => 'error',
-				'message'   => '%1$s() is for internal use only.',
+				'message'   => '`%1$s()` is for internal use only.',
 				'functions' => array(
 					'wpcom_vip_irc',
 				),
 			),
 			'rewrite_rules'            => array(
 				'type'      => 'error',
-				'message'   => '%s should not be used in any normal circumstances in the theme code.',
+				'message'   => '`%s` should not be used in any normal circumstances in the theme code.',
 				'functions' => array(
 					'flush_rewrite_rules',
 				),
 			),
 			'attachment_url_to_postid' => array(
 				'type'      => 'error',
-				'message'   => '%s() is prohibited, please use wpcom_vip_attachment_url_to_postid() instead.',
+				'message'   => '`%s()` is prohibited, please use `wpcom_vip_attachment_url_to_postid()` instead.',
 				'functions' => array(
 					'attachment_url_to_postid',
 				),
 			),
 			'strip_tags'               => array(
 				'type'      => 'error',
-				'message'   => '%s does not strip CSS and JS in between the script and style tags. `wp_strip_all_tags` should be used instead.',
+				'message'   => '`%s()` does not strip CSS and JS in between the script and style tags. `wp_strip_all_tags()` should be used instead.',
 				'functions' => array(
 					'strip_tags',
 				),
 			),
 			'wp_mail'                  => array(
 				'type'      => 'warning',
-				'message'   => '%s should be used sparingly. For any bulk emailing should be handled by a 3rd party service, in order to prevent domain or IP addresses being flagged as spam.',
+				'message'   => '`%s` should be used sparingly. For any bulk emailing should be handled by a 3rd party service, in order to prevent domain or IP addresses being flagged as spam.',
 				'functions' => array(
 					'wp_mail',
 					'mail',
@@ -79,7 +79,7 @@ public function getGroups() {
 			),
 			'is_multi_author'          => array(
 				'type'      => 'warning',
-				'message'   => '%s can be very slow on large sites and likely not needed on many VIP sites since they tend to have more than one author.',
+				'message'   => '`%s` can be very slow on large sites and likely not needed on many VIP sites since they tend to have more than one author.',
 				'functions' => array(
 					'is_multi_author',
 				),
@@ -94,7 +94,7 @@ public function getGroups() {
 		foreach ( $deprecated_vip_helpers as $restricted => $helper ) {
 			$new_groups[ $helper ] = array(
 				'type'      => 'warning',
-				'message'   => "%s() is deprecated, please use {$restricted} instead.",
+				'message'   => "`%s()` is deprecated, please use {$restricted} instead.",
 				'functions' => array(
 					$helper,
 				),
diff --git a/WordPressVIPMinimum/Sniffs/VIP/WPQueryParamsSniff.php b/WordPressVIPMinimum/Sniffs/VIP/WPQueryParamsSniff.php
@@ -46,12 +46,12 @@ public function process( File $phpcsFile, $stackPtr ) {
 			$next_token = $phpcsFile->findNext( array_merge( Tokens::$emptyTokens, array( T_EQUAL, T_CLOSE_SQUARE_BRACKET, T_DOUBLE_ARROW ) ), ( $stackPtr + 1 ), null, true );
 
 			if ( T_TRUE === $tokens[ $next_token ]['code'] ) {
-				$phpcsFile->addError( 'Setting suppress_filters to true is probihited.', $stackPtr, 'suppressFiltersTrue' );
+				$phpcsFile->addError( 'Setting `suppress_filters` to `true` is probihited.', $stackPtr, 'suppressFiltersTrue' );
 			}
 		}
 
 		if ( 'post__not_in' === trim( $tokens[ $stackPtr ]['content'], '\'' ) ) {
-			$phpcsFile->addWarning( 'Using post__not_in should be used with cautious.', $stackPtr, 'post__not_in' );
+			$phpcsFile->addWarning( 'Using `post__not_in` should be used with cautioun.', $stackPtr, 'post__not_in' );
 		}
 	}
 
diff --git a/WordPressVIPMinimum/Sniffs/Variables/VariableAnalysisSniff.php b/WordPressVIPMinimum/Sniffs/Variables/VariableAnalysisSniff.php
diff --git a/WordPressVIPMinimum/ruleset.xml b/WordPressVIPMinimum/ruleset.xml

Original file line number	Diff line number	Diff line change
`@@ -248,10 +248,10 @@ private function processFunctionBody( $stackPtr, $variableName ) {`
`248`	`248`	`}`
`249`	`249`	`} elseif ( $this->isInsideIfConditonal( $wpQueryVarUsed ) ) {`
`250`	`250`	`if ( ! $this->isParentConditionalCheckingMainQuery( $wpQueryVarUsed ) ) {`
`251`		`- $this->_phpcsFile->addWarning( 'Main WP_Query is being modified without $query->is_main_query() check. Needs manual inspection.', $wpQueryVarUsed, 'PreGetPosts' );`
	`251`	+ $this->_phpcsFile->addWarning( 'Main WP_Query is being modified without `$query->is_main_query()` check. Needs manual inspection.', $wpQueryVarUsed, 'PreGetPosts' );
`252`	`252`	`}`
`253`	`253`	`} elseif ( $this->isWPQueryMethodCall( $wpQueryVarUsed, 'set' ) ) {`
`254`		`- $this->_phpcsFile->addWarning( 'Main WP_Query is being modified without $query->is_main_query() check. Needs manual inspection.', $wpQueryVarUsed, 'PreGetPosts' );`
	`254`	+ $this->_phpcsFile->addWarning( 'Main WP_Query is being modified without `$query->is_main_query()` check. Needs manual inspection.', $wpQueryVarUsed, 'PreGetPosts' );
`255`	`255`	`}`
`256`	`256`	`$wpQueryVarUsed = $this->_phpcsFile->findNext(`
`257`	`257`	`array( T_VARIABLE ), // types.`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ public function process( File $phpcsFile, $stackPtr ) {`
`106`	`106`	`$variable_name = substr( $variable_name, 1, -1 );`
`107`	`107`
`108`	`108`	`if ( true === in_array( $variable_name, $this->whitelistes_batcache_params, true ) ) {`
`109`		`- $phpcsFile->addWarning( sprintf( 'Batcache whitelisted GET param, %s, found. Batcache whitelisted parameters get stripped and are not available in PHP.', $variable_name ), $stackPtr, 'strippedGetParam' );`
	`109`	+ $phpcsFile->addWarning( sprintf( 'Batcache whitelisted GET param, `%s`, found. Batcache whitelisted parameters get stripped and are not available in PHP.', $variable_name ), $stackPtr, 'strippedGetParam' );
`110`	`110`	`return;`
`111`	`111`	`}`
`112`	`112`	`}//end process()`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public function process( File $phpcsFile, $stackPtr ) {`
`97`	`97`	`$valueAfterEqualSign = $phpcsFile->findNext( Tokens::$emptyTokens, ( $rightAfterNextVariableOccurence + 1 ), null, true, null, true );`
`98`	`98`
`99`	`99`	`if ( T_FALSE === $tokens[ $valueAfterEqualSign ]['code'] ) {`
`100`		`- $phpcsFile->addError( sprintf( 'Obtained cached value in %s is being overriden. Disabling caching?', $variableName ), $nextVariableOccurrence, 'CacheValueOverride' );`
	`100`	+ $phpcsFile->addError( sprintf( 'Obtained cached value in `%s` is being overriden. Disabling caching?', $variableName ), $nextVariableOccurrence, 'CacheValueOverride' );
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`} //end Process()`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public function process( File $phpcsFile, $stackPtr ) {`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`if ( T_STRING === $tokens[ $stackPtr ]['code'] && true === in_array( $constantName, $this->restrictedConstantNames, true ) ) {`
`76`		`- $phpcsFile->addWarning( sprintf( 'Code is touching the %s constant. Make sure it\'s used appropriately.', $constantName ), $stackPtr, 'ConstantRestrictions' );`
	`76`	+ $phpcsFile->addWarning( sprintf( 'Code is touching the `%s` constant. Make sure it\'s used appropriately.', $constantName ), $stackPtr, 'ConstantRestrictions' );
`77`	`77`	`return;`
`78`	`78`	`}`
`79`	`79`
`@@ -101,9 +101,9 @@ public function process( File $phpcsFile, $stackPtr ) {`
`101`	`101`
`102`	`102`	`if ( true === in_array( $tokens[ $previous ]['code'], Tokens::$functionNameTokens, true ) ) {`
`103`	`103`	`if ( 'define' === $tokens[ $previous ]['content'] ) {`
`104`		`- $phpcsFile->addError( sprintf( 'The definition of %s constant is prohibited. Please use a different name.', $constantName ), $previous, 'ConstantRestrictions' );`
	`104`	+ $phpcsFile->addError( sprintf( 'The definition of `%s` constant is prohibited. Please use a different name.', $constantName ), $previous, 'ConstantRestrictions' );
`105`	`105`	`} elseif ( true === in_array( $constantName, $this->restrictedConstantNames, true ) ) {`
`106`		`- $phpcsFile->addWarning( sprintf( 'Code is touching the %s constant. Make sure it\'s used appropriately.', $constantName ), $previous, 'ConstantRestrictions' );`
	`106`	+ $phpcsFile->addWarning( sprintf( 'Code is touching the `%s` constant. Make sure it\'s used appropriately.', $constantName ), $previous, 'ConstantRestrictions' );
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function process( File $phpcsFile, $stackPtr ) {`
`61`	`61`	`$nextToken = $phpcsFile->findNext( Tokens::$emptyTokens, ( $nextToken + 1 ), null, true, null, true );`
`62`	`62`
`63`	`63`	`if ( T_CONSTANT_ENCAPSED_STRING !== $tokens[ $nextToken ]['code'] ) {`
`64`		`- $phpcsFile->addError( sprintf( 'Constant name, as a string, should be used along with %s().', $tokens[ $stackPtr ]['content'] ), $nextToken, 'NotCheckingConstantName' );`
	`64`	+ $phpcsFile->addError( sprintf( 'Constant name, as a string, should be used along with `%s()`.', $tokens[ $stackPtr ]['content'] ), $nextToken, 'NotCheckingConstantName' );
`65`	`65`	`return;`
`66`	`66`	`}`
`67`	`67`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ public function findDirectFunctionCalls( $stackPtr ) {`
`190`	`190`	`$next = $phpcsFile->findNext( Tokens::$functionNameTokens, $startNext, $closeBracket, false, null, true );`
`191`	`191`	`while ( $next ) {`
`192`	`192`	`if ( true === in_array( $tokens[ $next ]['content'], $this->catch[ $functionName ], true ) ) {`
`193`		`- $phpcsFile->addError( sprintf( "%s's return type must be checked before calling %s using that value", $tokens[ $next ]['content'], $functionName ), $next, 'CheckReturnValue' );`
	`193`	+ $phpcsFile->addError( sprintf( "`%s`'s return type must be checked before calling `%s` using that value", $tokens[ $next ]['content'], $functionName ), $next, 'CheckReturnValue' );
`194`	`194`	`}`
`195`	`195`	`$next = $phpcsFile->findNext( Tokens::$functionNameTokens, ( $next + 1 ), $closeBracket, false, null, true );`
`196`	`196`	`}`
`@@ -299,7 +299,7 @@ public function findNonCheckedVariables( $stackPtr ) {`
`299`	`299`	`if ( true === in_array( $tokens[ $nextFunctionCallWithVariable ]['code'], array_merge( Tokens::$functionNameTokens, $notFunctionsCallee ), true )`
`300`	`300`	`&& $tokens[ $nextFunctionCallWithVariable ]['content'] === $callee`
`301`	`301`	`) {`
`302`		`- $phpcsFile->addError( sprintf( 'Type of %s must be checked before calling %s using that variable', $variableName, $callee ), $nextFunctionCallWithVariable, 'CheckReturnValue' );`
	`302`	+ $phpcsFile->addError( sprintf( 'Type of `%s` must be checked before calling `%s()` using that variable', $variableName, $callee ), $nextFunctionCallWithVariable, 'CheckReturnValue' );
`303`	`303`	`return;`
`304`	`304`	`}`
`305`	`305`
`@@ -308,7 +308,7 @@ public function findNonCheckedVariables( $stackPtr ) {`
`308`	`308`	`if ( true === in_array( $tokens[ $next ]['code'], Tokens::$functionNameTokens, true )`
`309`	`309`	`&& $tokens[ $next ]['content'] === $callee`
`310`	`310`	`) {`
`311`		`- $phpcsFile->addError( sprintf( 'Type of %s must be checked before calling %s using that variable', $variableName, $callee ), $next, 'CheckReturnValue' );`
	`311`	+ $phpcsFile->addError( sprintf( 'Type of `%s` must be checked before calling `%s()` using that variable', $variableName, $callee ), $next, 'CheckReturnValue' );
`312`	`312`	`return;`
`313`	`313`	`}`
`314`	`314`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public function process( File $phpcsFile, $stackPtr ) {`
`81`	`81`	`while ( $nextToken < $parenthesis_closer ) {`
`82`	`82`	`$nextToken = $phpcsFile->findNext( Tokens::$emptyTokens, ( $nextToken + 1 ), null, true, null, true );`
`83`	`83`	`if ( T_STRING === $tokens[ $nextToken ]['code'] ) {`
`84`		`- $phpcsFile->addWarning( sprintf( 'Any HTML passed to %s gets executed. Make sure it\'s properly escaped.', $tokens[ $stackPtr ]['content'] ), $stackPtr, $tokens[ $stackPtr ]['content'] );`
	`84`	+ $phpcsFile->addWarning( sprintf( 'Any HTML passed to `%s` gets executed. Make sure it\'s properly escaped.', $tokens[ $stackPtr ]['content'] ), $stackPtr, $tokens[ $stackPtr ]['content'] );
`85`	`85`	`return;`
`86`	`86`	`}`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public function process( File $phpcsFile, $stackPtr ) {`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`if ( true === $foundVariable ) {`
`87`		`- $phpcsFile->addWarning( sprintf( 'Any HTML passed to %s gets executed. Consider using .textContent or make sure that used variables are properly escaped.', $tokens[ $stackPtr ]['content'] ), $stackPtr, $tokens[ $stackPtr ]['content'] );`
	`87`	+ $phpcsFile->addWarning( sprintf( 'Any HTML passed to `%s` gets executed. Consider using `.textContent` or make sure that used variables are properly escaped.', $tokens[ $stackPtr ]['content'] ), $stackPtr, $tokens[ $stackPtr ]['content'] );
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`}//end process()`