Docs: clarify the $matched_content parameter

WordPress/AbstractClassRestrictionsSniff.php

@@ -191,6 +191,26 @@ public function check_for_matches( $stackPtr ) {
 		return min( $skip_to );
 	}
 
+	/**
+	 * Process a matched token.
+	 *
+	 * @since 0.11.0 Split out from the `process()` method.
+	 *
+	 * @param int    $stackPtr        The position of the current token in the stack.
+	 * @param string $group_name      The name of the group which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in it original case.
+	 *
+	 * @return int|void Integer stack pointer to skip forward or void to continue
+	 *                  normal file processing.
+	 *
+	 * @phpcs:disable Generic.CodeAnalysis.UselessOverridingMethod.Found
+	 */
+	public function process_matched_token( $stackPtr, $group_name, $matched_content ) {
+		parent::process_matched_token( $stackPtr, $group_name, $matched_content );
+	}
+	// phpcs:enable
+
 	/**
 	 * Prepare the class name for use in a regular expression.
 	 *

WordPress/AbstractFunctionParameterSniff.php

@@ -62,7 +62,8 @@ public function getGroups() {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 *
 	 * @return int|void Integer stack pointer to skip forward or void to continue
 	 *                  normal file processing.
@@ -85,7 +86,8 @@ public function process_matched_token( $stackPtr, $group_name, $matched_content
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return int|void Integer stack pointer to skip forward or void to continue
@@ -101,7 +103,8 @@ abstract public function process_parameters( $stackPtr, $group_name, $matched_co
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 *
 	 * @return int|void Integer stack pointer to skip forward or void to continue
 	 *                  normal file processing.

WordPress/AbstractFunctionRestrictionsSniff.php

@@ -320,7 +320,8 @@ public function check_for_matches( $stackPtr ) {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 *
 	 * @return int|void Integer stack pointer to skip forward or void to continue
 	 *                  normal file processing.

WordPress/Sniffs/CodeAnalysis/EscapedNotTranslatedSniff.php

@@ -57,7 +57,8 @@ final class EscapedNotTranslatedSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/DateTime/CurrentTimeTimestampSniff.php

@@ -59,7 +59,8 @@ final class CurrentTimeTimestampSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/NamingConventions/PrefixAllGlobalsSniff.php

@@ -806,7 +806,8 @@ protected function process_list_assignment( $stackPtr ) {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/NamingConventions/ValidHookNameSniff.php

@@ -87,7 +87,8 @@ public function getGroups() {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/NamingConventions/ValidPostTypeSlugSniff.php

@@ -117,7 +117,8 @@ public function register() {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param array  $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/PHP/IniSetSniff.php

@@ -137,7 +137,8 @@ final class IniSetSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/PHP/PregQuoteDelimiterSniff.php

@@ -50,7 +50,8 @@ final class PregQuoteDelimiterSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/PHP/StrictInArraySniff.php

@@ -77,7 +77,8 @@ final class StrictInArraySniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/Security/PluginMenuSlugSniff.php

@@ -106,7 +106,8 @@ final class PluginMenuSlugSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/Utils/I18nTextDomainFixerSniff.php

@@ -467,7 +467,8 @@ public function process_token( $stackPtr ) {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void
@@ -594,7 +595,8 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 *
 	 * @return void
 	 */

WordPress/Sniffs/WP/AlternativeFunctionsSniff.php

@@ -214,7 +214,8 @@ public function getGroups() {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 *
 	 * @return int|void Integer stack pointer to skip forward or void to continue
 	 *                  normal file processing.

WordPress/Sniffs/WP/CapabilitiesSniff.php

@@ -352,14 +352,14 @@ final class CapabilitiesSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param array  $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void
 	 */
 	public function process_parameters( $stackPtr, $group_name, $matched_content, $parameters ) {
-		$function_name_lc = strtolower( $matched_content );
-		$function_details = $this->target_functions[ $function_name_lc ];
+		$function_details = $this->target_functions[ $matched_content ];
 
 		$parameter = PassedParameters::getParameterFromStack(
 			$parameters,

WordPress/Sniffs/WP/ClassNameCaseSniff.php

@@ -630,6 +630,7 @@ public function getGroups() {
 	 * @param string $group_name      The name of the group which was matched. Will
 	 *                                always be 'wp_classes'.
 	 * @param string $matched_content The token content (class name) which was matched.
+	 *                                in its original case.
 	 *
 	 * @return void
 	 */

WordPress/Sniffs/WP/DeprecatedClassesSniff.php

@@ -91,7 +91,8 @@ public function getGroups() {
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched. Will
 	 *                                always be 'deprecated_classes'.
-	 * @param string $matched_content The token content (class name) which was matched.
+	 * @param string $matched_content The token content (class name) which was matched
+	 *                                in its original case.
 	 *
 	 * @return void
 	 */

WordPress/Sniffs/WP/DeprecatedFunctionsSniff.php

@@ -1520,32 +1520,31 @@ public function getGroups() {
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched. Will
 	 *                                always be 'deprecated_functions'.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 *
 	 * @return void
 	 */
 	public function process_matched_token( $stackPtr, $group_name, $matched_content ) {
 
 		$this->set_minimum_wp_version();
 
-		$function_name = strtolower( $matched_content );
-
 		$message = '%s() has been deprecated since WordPress version %s.';
 		$data    = array(
-			$matched_content,
-			$this->deprecated_functions[ $function_name ]['version'],
+			$this->tokens[ $stackPtr ]['content'],
+			$this->deprecated_functions[ $matched_content ]['version'],
 		);
 
-		if ( ! empty( $this->deprecated_functions[ $function_name ]['alt'] ) ) {
+		if ( ! empty( $this->deprecated_functions[ $matched_content ]['alt'] ) ) {
 			$message .= ' Use %s instead.';
-			$data[]   = $this->deprecated_functions[ $function_name ]['alt'];
+			$data[]   = $this->deprecated_functions[ $matched_content ]['alt'];
 		}
 
 		MessageHelper::addMessage(
 			$this->phpcsFile,
 			$message,
 			$stackPtr,
-			( $this->wp_version_compare( $this->deprecated_functions[ $function_name ]['version'], $this->minimum_wp_version, '<' ) ),
+			( $this->wp_version_compare( $this->deprecated_functions[ $matched_content ]['version'], $this->minimum_wp_version, '<' ) ),
 			MessageHelper::stringToErrorcode( $matched_content . 'Found' ),
 			$data
 		);

WordPress/Sniffs/WP/DeprecatedParameterValuesSniff.php

@@ -218,7 +218,8 @@ final class DeprecatedParameterValuesSniff extends AbstractFunctionParameterSnif
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void
@@ -243,7 +244,8 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 	 *
 	 * @since 1.0.0
 	 *
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameter       Array with start and end token positon of the parameter.
 	 * @param array  $parameter_args  Array with alternative and WordPress deprecation version of the parameter.
 	 *

WordPress/Sniffs/WP/DeprecatedParametersSniff.php

@@ -316,7 +316,8 @@ final class DeprecatedParametersSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void

WordPress/Sniffs/WP/DiscouragedConstantsSniff.php

@@ -201,14 +201,14 @@ public function process_arbitrary_tstring( $stackPtr ) {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void
 	 */
 	public function process_parameters( $stackPtr, $group_name, $matched_content, $parameters ) {
-		$function_name = strtolower( $matched_content );
-		$target_param  = $this->target_functions[ $function_name ];
+		$target_param = $this->target_functions[ $matched_content ];
 
 		// Was the target parameter passed ?
 		$found_param = PassedParameters::getParameterFromStack( $parameters, $target_param['position'], $target_param['name'] );

WordPress/Sniffs/WP/EnqueuedResourceParametersSniff.php

@@ -114,7 +114,8 @@ public function register() {
 	 *
 	 * @param int    $stackPtr        The position of the current token in the stack.
 	 * @param string $group_name      The name of the group which was matched.
-	 * @param string $matched_content The token content (function name) which was matched.
+	 * @param string $matched_content The token content (function name) which was matched
+	 *                                in lowercase.
 	 * @param array  $parameters      Array with information about the parameters.
 	 *
 	 * @return void