Allow presence of comments inside the first argument (hook name).

Add test.

Author: kagg-design

WPForms/Sniffs/PHP/ValidateHooksSniff.php

@@ -87,6 +87,8 @@ public function process( File $phpcsFile, $stackPtr ) {
 	 */
 	private function getFirstArgument( $phpcsFile, $stackPtr ) {
 
+		$blankTokens = [ T_WHITESPACE, T_COMMENT, T_PHPCS_IGNORE ];
+
 		$tokens   = $phpcsFile->getTokens();
 		$openPtr  = $phpcsFile->findNext( T_OPEN_PARENTHESIS, $stackPtr );
 		$closePtr = $tokens[ $openPtr ]['parenthesis_closer'];
@@ -96,7 +98,10 @@ private function getFirstArgument( $phpcsFile, $stackPtr ) {
 			$closePtr = $commaPtr;
 		}
 
-		$firstArgument = trim( $phpcsFile->getTokensAsString( $openPtr + 1, $closePtr - $openPtr - 1 ) );
+		$openPtr  = $phpcsFile->findNext( $blankTokens, $openPtr + 1, $closePtr, true );
+		$closePtr = $phpcsFile->findPrevious( $blankTokens, $closePtr - 1, $openPtr, true );
+
+		$firstArgument = trim( $phpcsFile->getTokensAsString( $openPtr, $closePtr - $openPtr + 1 ) );
 
 		return strtolower(
 			preg_replace( '/[\'\"]/', '', $firstArgument )

WPForms/Tests/TestedFiles/PHP/ValidateHooks.php

@@ -17,6 +17,11 @@ public function useHooks() {
 		apply_filters( "wpforms_tests_testedfiles_php_validate_hooks_{$extra}_detail", true );
 		do_action( "wpforms_tests_testedfiles_php_validate_hooks_{$extra}_detail" );
 
+		echo apply_filters( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+			"wpforms_tests_testedfiles_php_validate_hooks_{$extra}_detail",
+			true
+		);
+
 		// Invalid.
 		apply_filters( 'tests_testedfiles_php_validate_hooks', true );
 		apply_filters( 'tests_testedfiles_php_validate_hooks_extra_detail', true );

WPForms/Tests/Tests/PHP/ValidateHooksTest.php

@@ -21,6 +21,6 @@ public function testProcess() {
 
 		$phpcsFile = $this->process( new ValidateHooksSniff() );
 
-		$this->fileHasErrors( $phpcsFile, 'InvalidHookName', [ 21, 22, 23, 24, 26, 27 ] );
+		$this->fileHasErrors( $phpcsFile, 'InvalidHookName', [ 26, 27, 28, 29, 31, 32 ] );
 	}
 }