Allow filters callbacks to return null on purpose

Author: gmazzap

Inpsyde/Sniffs/CodeQuality/HookClosureReturnSniff.php

@@ -34,11 +34,18 @@ public function process(File $file, $position)
         }
 
         list($functionStart, $functionEnd) = PhpcsHelpers::functionBoundaries($file, $position);
-        if (!$functionStart < 0 || $functionEnd <= 0) {
+        if ($functionStart < 0 || $functionEnd <= 0) {
             return;
         }
 
-        list($nonVoidReturnCount, $voidReturnCount) = PhpcsHelpers::countReturns($file, $position);
+        list(
+            $nonVoidReturnCount,
+            $voidReturnCount,
+            $nullReturnsCount
+        ) = PhpcsHelpers::countReturns($file, $position);
+
+        // Allow a filter to return null on purpose
+        $nonVoidReturnCount += $nullReturnsCount;
 
         $isFilterClosure = PhpcsHelpers::isHookClosure($file, $position, true, false);
 

tests/fixtures/hook-closure-return.php

@@ -69,6 +69,13 @@ function() {
         }
     );
 
+    add_filter(
+        'hook',
+        function () {
+            return null;
+        }
+    );
+
     return true;
 }
 
@@ -107,4 +114,4 @@ function() {
             }
         );
     }
-}
+}