Narrow parameter type for register_widget() (#419)

Author: IanDelMar

functionMap.php

@@ -143,6 +143,7 @@
     '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'],
+    'register_widget' => ['void', 'widget' => 'class-string<\WP_Widget>|\WP_Widget'],
     '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

@@ -252,6 +252,19 @@ public function testRegisterUninstallHook(): void
         );
     }
 
+    public function testRegisterWidget(): void
+    {
+        $this->analyse(
+            __DIR__ . '/data/param/register-widget.php',
+            [
+                ['Parameter #1 $widget of function register_widget expects class-string<WP_Widget>|WP_Widget, PhpStubs\WordPress\Core\Tests\NoWidget given.', 21],
+                ['Parameter #1 $widget of function register_widget expects class-string<WP_Widget>|WP_Widget, PhpStubs\WordPress\Core\Tests\NoWidget given.', 22],
+                ['Parameter #1 $widget of function register_widget expects class-string<WP_Widget>|WP_Widget, string given.', 23],
+                ['Parameter #1 $widget of function register_widget expects class-string<WP_Widget>|WP_Widget, string given.', 24],
+            ]
+        );
+    }
+
     public function testWpdbGetRow(): void
     {
         $this->analyse(

tests/data/param/register-widget.php

@@ -0,0 +1,31 @@
+<?php // phpcs:disable
+
+declare(strict_types=1);
+
+namespace PhpStubs\WordPress\Core\Tests;
+
+use WP_Widget;
+use function register_widget;
+
+class MyWidget extends WP_Widget {
+    public function __construct(string $id_base, string $name)
+    {
+        parent::__construct($id_base, $name);
+    }
+}
+
+class NoWidget {}
+
+// Incorrect
+$noWidget = new NoWidget();
+register_widget($noWidget);
+register_widget(new NoWidget());
+register_widget(NoWidget::class);
+register_widget('\PhpStubs\WordPress\Core\Tests\NoWidget');
+
+// Correct
+$widget = new MyWidget('my_widget', 'My Widget');
+register_widget($widget);
+register_widget(new MyWidget('my_widget', 'My Widget'));
+register_widget(MyWidget::class);
+register_widget('\PhpStubs\WordPress\Core\Tests\MyWidget');

wordpress-stubs.php

@@ -149029,6 +149029,8 @@ function wp_is_mobile()
      * @global WP_Widget_Factory $wp_widget_factory
      *
      * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
+     * @phpstan-param class-string<\WP_Widget>|\WP_Widget $widget
+     * @phpstan-return void
      */
     function register_widget($widget)
     {