Fix wrong @param tag counting when a hook has no arguments.

awesomemotive · Jan 11, 2022 · 449b1e2 · 449b1e2
1 parent e7dcf55
commit 449b1e2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/WPForms/Sniffs/Comments/ParamTagHooksSniff.php b/WPForms/Sniffs/Comments/ParamTagHooksSniff.php
@@ -112,7 +112,13 @@ private function countArguments( $phpcsFile, $stackPtr ) { // phpcs:ignore Gener
 		$tokens          = $phpcsFile->getTokens();
 		$openParenthesis = $phpcsFile->findNext( [ T_OPEN_PARENTHESIS ], $stackPtr + 1 );
 		$lastPosition    = $tokens[ $openParenthesis ]['parenthesis_closer'] - 1;
-		$currentPosition = $phpcsFile->findNext( T_COMMA, $stackPtr + 1 ) + 1;
+		$commaPtr        = $phpcsFile->findNext( T_COMMA, $stackPtr + 1 );
+
+		if ( $commaPtr === false ) {
+			return 0;
+		}
+
+		$currentPosition = $commaPtr + 1;
 		$quantity        = 0;
 
 		while ( $currentPosition < $lastPosition ) {

diff --git a/WPForms/Tests/TestFiles/Comments/ParamTagHooks.php b/WPForms/Tests/TestFiles/Comments/ParamTagHooks.php
@@ -180,3 +180,6 @@ function () {
 
 /** This action is documented in some-class.php. */
 do_action( 'wpforms_display_submit_after', $this->displaysubmit_after_action );
+
+// This case generated 'You should have 39 @param tags' (39 as an example).
+do_action( 'hook_without_args' );