Skip to content

Fix bugs and adopt PHPCSUtils in AlwaysReturnInFilterSniff #881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GaryJones merged 1 commit into from
Mar 22, 2026
Merged

Fix bugs and adopt PHPCSUtils in AlwaysReturnInFilterSniff #881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions WordPressVIPMinimum/Sniffs/Hooks/AlwaysReturnInFilterSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use PHP_CodeSniffer\Util\Tokens;
use PHPCSUtils\Utils\Arrays;
use PHPCSUtils\Utils\FunctionDeclarations;
use PHPCSUtils\Utils\TextStrings;
use WordPressVIPMinimum\Sniffs\Sniff;

/**
Expand Down Expand Up @@ -80,6 +81,9 @@ public function process_token( $stackPtr ) {

if ( $this->tokens[ $callbackPtr ]['code'] === T_CLOSURE ) {
$this->processFunctionBody( $callbackPtr );
} elseif ( $this->tokens[ $callbackPtr ]['code'] === T_FN ) {
// Arrow functions always return a value implicitly. No check needed.
return;
} elseif ( $this->tokens[ $callbackPtr ]['code'] === T_ARRAY
|| $this->tokens[ $callbackPtr ]['code'] === T_OPEN_SHORT_ARRAY
) {
Expand Down Expand Up @@ -133,7 +137,7 @@ private function processArray( $stackPtr ) {
*/
private function processString( $stackPtr, $start = 0, $end = null ) {

$callbackFunctionName = substr( $this->tokens[ $stackPtr ]['content'], 1, -1 );
$callbackFunctionName = TextStrings::stripQuotes( $this->tokens[ $stackPtr ]['content'] );

$callbackFunctionPtr = $this->phpcsFile->findNext(
T_STRING,
Expand Down Expand Up @@ -165,10 +169,10 @@ private function processFunction( $stackPtr, $start = 0, $end = null ) {
$functionName = $this->tokens[ $stackPtr ]['content'];

$offset = $start;
while ( $this->phpcsFile->findNext( [ T_FUNCTION ], $offset, $end ) !== false ) {
$functionStackPtr = $this->phpcsFile->findNext( [ T_FUNCTION ], $offset, $end );
$functionNamePtr = $this->phpcsFile->findNext( Tokens::$emptyTokens, $functionStackPtr + 1, null, true, null, true );
if ( $this->tokens[ $functionNamePtr ]['code'] === T_STRING && $this->tokens[ $functionNamePtr ]['content'] === $functionName ) {
// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition -- Valid usage.
while ( ( $functionStackPtr = $this->phpcsFile->findNext( T_FUNCTION, $offset, $end ) ) !== false ) {
$declaredName = FunctionDeclarations::getName( $this->phpcsFile, $functionStackPtr );
if ( $declaredName === $functionName ) {
$this->processFunctionBody( $functionStackPtr );
return;
}
Expand Down Expand Up @@ -294,7 +298,7 @@ private function isInsideIfConditonal( $stackPtr ) {
private function isReturningVoid( $stackPtr ) {

$nextToReturnTokenPtr = $this->phpcsFile->findNext(
[ Tokens::$emptyTokens ],
Tokens::$emptyTokens,
$stackPtr + 1,
null,
true
Expand Down
9 changes: 9 additions & 0 deletions WordPressVIPMinimum/Tests/Hooks/AlwaysReturnInFilterUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,15 @@ class tokenizer_bug_test {
public function tokenizer_bug( $param ): namespace\Foo {} // Error.
}

// Arrow function callbacks always return implicitly. Ok.
add_filter( 'good_arrow_function', fn( $x ) => $x . ' suffix' );

add_filter( 'good_arrow_function_null', fn( $x ) => null ); // Ok, still returns a value (null).

add_filter( 'bad_void_return_with_space', function() { // Error.
return ;
} );

// Intentional parse error. This has to be the last test in the file!
class parse_error_test {
public function __construct() {
Expand Down
1 change: 1 addition & 0 deletions WordPressVIPMinimum/Tests/Hooks/AlwaysReturnInFilterUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public function getErrorList() {
129 => 1,
163 => 1,
188 => 1,
196 => 1,
];
}

Expand Down
Loading