Narrow parameter type for add_feed()

Author: IanDelMar

functionMap.php

@@ -40,7 +40,7 @@
     'absint' => ['($maybeint is T&int<0, max> ? T : ($maybeint is int<min, -1> ? int<1, max> : ($maybeint is empty ? 0 : ($maybeint is numeric-string ? int<0, max> : ($maybeint is string ? 0 : ($maybeint is true|non-empty-array ? 1 : ($maybeint is bool ? 0|1 : int<0, max>)))))))', '@phpstan-template T' => 'of int', 'maybeint' => 'T|scalar|array|resource|null', '@phpstan-pure' => ''],
     'add_comments_page' => [null, 'callback' => "''|callable"],
     'add_dashboard_page' => [null, 'callback' => "''|callable"],
-    'add_feed' => ['non-falsy-string'],
+    'add_feed' => ['non-falsy-string', 'callback' => 'callable(bool, string): void'],
     'add_link' => ['int<0, max>'],
     'add_links_page' => [null, 'callback' => "''|callable"],
     'add_management_page' => [null, 'callback' => "''|callable"],

tests/Faker.php

@@ -104,10 +104,12 @@ public static function list($type = null): array
      * @param TKeyOrValue $keyOrValueType
      * @param TValue $valueType
      * @return (TKeyOrValue is null ? non-empty-array<mixed> : (TValue is null ? non-empty-array<TKeyOrValue> : non-empty-array<TKeyOrValue, TValue>))
+     *
+     * @phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
      */
     public static function nonEmptyArray($keyOrValueType = null, $valueType = null): array
     {
-        return [$keyOrValueType => $valueType];
+        return ['non-empty'];
     }
 
     /**

tests/ParameterTypeTest.php

@@ -28,6 +28,22 @@ public function testAbsint(): void
         );
     }
 
+    public function testAddFeed(): void
+    {
+        $this->analyse(
+            __DIR__ . '/data/param/add-feed.php',
+            [
+                ["Parameter #2 \$callback of function add_feed expects callable(bool, string): void, '' given.", 19],
+                ['Parameter #2 $callback of function add_feed expects callable(bool, string): void, Closure(int): void given.', 20],
+                ['Parameter #2 $callback of function add_feed expects callable(bool, string): void, Closure(bool, int): void given.', 21],
+                ['Parameter #2 $callback of function add_feed expects callable(bool, string): void, Closure(bool, string): int given.', 22],
+                ["Parameter #2 \$callback of function add_feed expects callable(bool, string): void, 'addFeedNotOkFirst' given.", 23],
+                ["Parameter #2 \$callback of function add_feed expects callable(bool, string): void, 'addFeedNotOkSecond' given.", 24],
+                ["Parameter #2 \$callback of function add_feed expects callable(bool, string): void, 'addFeedNotOkReturn' given.", 25],
+            ]
+        );
+    }
+
     public function testAddMenuPage(): void
     {
         $this->analyse(

tests/data/param/add-feed.php

@@ -0,0 +1,33 @@
+<?php
+
+// phpcs:disable
+
+declare(strict_types=1);
+
+use PhpStubs\WordPress\Core\Tests\Faker;
+
+$feedname = Faker::string();
+
+function addFeedNotOkFirst(int $isCommentFeed): void {}
+function addFeedNotOkSecond(bool $isCommentFeed, int $feed): void {}
+function addFeedNotOkReturn(bool $isCommentFeed, string $feed): int {return Faker::int();}
+function addFeedCorrect(bool $isCommentFeed, string $feed): void {}
+function addFeedCorrectFirst(bool $isCommentFeed): void {}
+function addFeedCorrectNoParams(): void {}
+
+// Incorrect usages
+add_feed($feedname, ''); // Not a callable
+add_feed($feedname, static function (int $isCommentFeed): void {}); // Incorrect type for $isCommentFeed
+add_feed($feedname, static function (bool $isCommentFeed, int $feed): void {}); // Incorrect type for $feed
+add_feed($feedname, static function (bool $isCommentFeed, string $feed): int {return Faker::int();}); // Incorrect callback return type
+add_feed($feedname, 'addFeedNotOkFirst'); // Incorrect type for $isCommentFeed
+add_feed($feedname, 'addFeedNotOkSecond'); // Incorrect type for $feed
+add_feed($feedname, 'addFeedNotOkReturn'); // Incorrect callback return type
+
+// Correct usages
+add_feed($feedname, static function (bool $isCommentFeed, string $feed): void {});
+add_feed($feedname, static function (bool $isCommentFeed): void {});
+add_feed($feedname, static function (): void {});
+add_feed($feedname, 'addFeedCorrect');
+add_feed($feedname, 'addFeedCorrectFirst');
+add_feed($feedname, 'addFeedCorrectNoParams');

wordpress-stubs.php

@@ -136496,6 +136496,7 @@ function remove_permastruct($name)
      * @param string   $feedname Feed name. Should not start with '_'.
      * @param callable $callback Callback to run on feed display.
      * @return string Feed action name.
+     * @phpstan-param callable(bool, string): void $callback
      * @phpstan-return non-falsy-string
      */
     function add_feed($feedname, $callback)