Narrow $callback type for register_activation/deactivation/uninstall_hook() (#401)

* Narrow $callback type for register_activation/deactivation/uninstall_hook()

* Update ParameterTypeTest.php

Author: IanDelMar

functionMap.php

@@ -137,8 +137,11 @@
     'prep_atom_text_construct' => ["array{'html'|'text'|'xhtml', string}"],
     'previous_posts' => ['($display is true ? void : string)'],
     'rawurlencode_deep' => ['T', '@phpstan-template' => 'T', 'value' => 'T'],
+    'register_activation_hook' => ['void', 'callback' => 'callable(bool): void'],
+    'register_deactivation_hook' => ['void', 'callback' => 'callable(bool): void'],
     'register_nav_menus' => [null, 'locations' => 'array<string, string>'],
     'register_post_type' => [null, 'post_type' => 'lowercase-string&non-empty-string'],
+    'register_uninstall_hook' => ['void', 'callback' => 'callable(): void'],
     'render_block_core_categories' => ['non-falsy-string'],
     'rest_authorization_required_code' => ['401|403'],
     'rest_sanitize_boolean' => ["(T is bool ? T : (T is ''|'false'|'FALSE'|'0'|0 ? false : true))", '@phpstan-template T' => 'of bool|string|int', 'value' => 'T', '@phpstan-pure' => ''],

tests/ParameterTypeTest.php

@@ -155,6 +155,28 @@ public function testCheckAjaxReferer(): void
         );
     }
 
+    public function testRegisterActivationHook(): void
+    {
+        $this->analyse(
+            __DIR__ . '/data/param/register-activation-hook.php',
+            [
+                ['Parameter #2 $callback of function register_activation_hook expects callable(bool): void, Closure(string): void given.', 10],
+                ['Parameter #2 $callback of function register_activation_hook expects callable(bool): void, Closure(bool): int given.', 11],
+            ]
+        );
+    }
+
+    public function testRegisterDeactivationHook(): void
+    {
+        $this->analyse(
+            __DIR__ . '/data/param/register-deactivation-hook.php',
+            [
+                ['Parameter #2 $callback of function register_deactivation_hook expects callable(bool): void, Closure(string): void given.', 10],
+                ['Parameter #2 $callback of function register_deactivation_hook expects callable(bool): void, Closure(bool): int given.', 11],
+            ]
+        );
+    }
+
     public function testDoAction(): void
     {
         $this->analyse(
@@ -199,6 +221,17 @@ public function testRegisterPostType(): void
         );
     }
 
+    public function testRegisterUninstallHook(): void
+    {
+        $this->analyse(
+            __DIR__ . '/data/param/register-uninstall-hook.php',
+            [
+                ['Parameter #2 $callback of function register_uninstall_hook expects callable(): void, Closure(bool): void given.', 10],
+                ['Parameter #2 $callback of function register_uninstall_hook expects callable(): void, Closure(): int given.', 11],
+            ]
+        );
+    }
+
     public function testWpdbGetRow(): void
     {
         $this->analyse(

tests/data/param/register-activation-hook.php

@@ -0,0 +1,15 @@
+<?php // phpcs:disable
+
+declare(strict_types=1);
+
+use PhpStubs\WordPress\Core\Tests\Faker;
+
+$file = Faker::string();
+
+// Incorrect $callback
+register_activation_hook($file, static function (string $incorrect): void {}); // Incorrect parameter type
+register_activation_hook($file, static function (bool $correct): int {return Faker::int();}); // Incorrect return type
+
+// Correct $callback
+register_activation_hook($file, static function (): void {});
+register_activation_hook($file, static function (bool $correct): void {});

tests/data/param/register-deactivation-hook.php

@@ -0,0 +1,15 @@
+<?php // phpcs:disable
+
+declare(strict_types=1);
+
+use PhpStubs\WordPress\Core\Tests\Faker;
+
+$file = Faker::string();
+
+// Incorrect $callback
+register_deactivation_hook($file, static function (string $incorrect): void {}); // Incorrect parameter type
+register_deactivation_hook($file, static function (bool $correct): int {return Faker::int();}); // Incorrect return type
+
+// Correct $callback
+register_deactivation_hook($file, static function (): void {});
+register_deactivation_hook($file, static function (bool $correct): void {});

tests/data/param/register-uninstall-hook.php

@@ -0,0 +1,14 @@
+<?php // phpcs:disable
+
+declare(strict_types=1);
+
+use PhpStubs\WordPress\Core\Tests\Faker;
+
+$file = Faker::string();
+
+// Incorrect $callback
+register_uninstall_hook($file, static function (bool $incorrect): void {}); // Incorrect number of parameters
+register_uninstall_hook($file, static function (): int {return Faker::int();}); // Incorrect return type
+
+// Correct $callback
+register_uninstall_hook($file, static function (): void {});

wordpress-stubs.php

@@ -129868,6 +129868,8 @@ function plugin_dir_url($file)
      *
      * @param string   $file     The filename of the plugin including the path.
      * @param callable $callback The function hooked to the 'activate_PLUGIN' action.
+     * @phpstan-param callable(bool): void $callback
+     * @phpstan-return void
      */
     function register_activation_hook($file, $callback)
     {
@@ -129889,6 +129891,8 @@ function register_activation_hook($file, $callback)
      *
      * @param string   $file     The filename of the plugin including the path.
      * @param callable $callback The function hooked to the 'deactivate_PLUGIN' action.
+     * @phpstan-param callable(bool): void $callback
+     * @phpstan-return void
      */
     function register_deactivation_hook($file, $callback)
     {
@@ -129918,6 +129922,7 @@ function register_deactivation_hook($file, $callback)
      * @param string   $file     Plugin file.
      * @param callable $callback The callback to run when the hook is called. Must be
      *                           a static method or function.
+     * @phpstan-param callable(): void $callback
      * @phpstan-return void
      */
     function register_uninstall_hook($file, $callback)