Narrow parameter type for add_shortcode (#377)

* Narrow parameter type for add_shortcode

* Update ParameterTypeTest.php

Author: IanDelMar

functionMap.php

@@ -49,6 +49,7 @@
     'add_pages_page' => [null, 'callback' => "''|callable"],
     'add_plugins_page' => [null, 'callback' => "''|callable"],
     'add_posts_page' => [null, 'callback' => "''|callable"],
+    'add_shortcode' => [null, 'tag' => 'non-empty-string'],
     'add_submenu_page' => [null, 'callback' => "''|callable"],
     'add_theme_page' => [null, 'callback' => "''|callable"],
     'add_users_page' => [null, 'callback' => "''|callable"],

tests/ParameterTypeTest.php

@@ -50,6 +50,19 @@ public function testAddMenuPage(): void
         );
     }
 
+    public function testAddShortcode(): void
+    {
+        $this->analyse(
+            __DIR__ . '/data/param/add-shortcode.php',
+            [
+                ['Parameter #1 $tag of function add_shortcode expects non-empty-string, 1 given.', 10],
+                ["Parameter #1 \$tag of function add_shortcode expects non-empty-string, '' given.", 11],
+                // Maybes
+                ['Parameter #1 $tag of function add_shortcode expects non-empty-string, string given.', 14],
+            ]
+        );
+    }
+
     public function testBookmarks(): void
     {
         $field = "'link_category'|'link_description'|'link_id'|'link_image'|'link_name'|'link_notes'|'link_owner'|'link_rating'|'link_rel'|'link_rss'|'link_target'|'link_updated'|'link_url'|'link_visible'";

tests/data/param/add-shortcode.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpStubs\WordPress\Core\Tests;
+
+use function add_shortcode;
+
+// Incorrect $tag
+add_shortcode(1, Faker::callable());
+add_shortcode('', Faker::callable());
+
+// Maybe incorrect $tag
+add_shortcode(Faker::string(), Faker::callable());
+
+// Correct $tag
+add_shortcode('0', Faker::callable()); // '0' is a valid tag
+add_shortcode('tag', Faker::callable());
+add_shortcode(Faker::nonEmptyString(), Faker::callable()); // '0' is a valid tag
+add_shortcode(Faker::nonFalsyString(), Faker::callable());

wordpress-stubs.php

@@ -137586,6 +137586,7 @@ function wp_default_script_modules()
      *                           including an array of attributes (`$atts`), the shortcode content
      *                           or null if not set (`$content`), and finally the shortcode tag
      *                           itself (`$shortcode_tag`), in that order.
+     * @phpstan-param non-empty-string $tag
      * @phpstan-return void
      */
     function add_shortcode($tag, $callback)