Add conditional return type and narrow argument type for has_shortcode() (#361)

Author: IanDelMar

functionMap.php

@@ -108,6 +108,7 @@
     'get_user_by' => ["(\$field is 'id'|'ID' ? (\$value is int<min, 0> ? false : \WP_User|false) : \WP_User|false)"],
     'has_action' => ['($callback is false ? bool : false|int)'],
     'has_filter' => ['($callback is false ? bool : false|int)'],
+    'has_shortcode' => ['($tag is empty ? false : ($content is empty ? false : bool))', '@phpstan-assert-if-true =non-falsy-string $content' => '', '@phpstan-assert-if-true =non-empty-string $tag' => ''],
     'have_posts' => [null, '@phpstan-impure' => ''],
     'image_link_input_fields' => ['non-falsy-string'],
     'image_size_input_fields' => ["array{label: string, input: 'html', html: string}"],

tests/TypeInferenceTest.php

@@ -54,6 +54,7 @@ public function dataFileAsserts(): iterable
         yield from $this->gatherAssertTypes(__DIR__ . '/data/get_user.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/get_user_by.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/has_filter.php');
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/has_shortcode.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/have_posts.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/image_link_input_fields.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/image_size_input_fields.php');

tests/data/has_shortcode.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpStubs\WordPress\Core\Tests;
+
+use function PHPStan\Testing\assertType;
+
+/*
+ * Check return type
+ */
+
+assertType('false', has_shortcode('', ''));
+assertType('false', has_shortcode('', 'foo'));
+assertType('false', has_shortcode('foo', ''));
+assertType('bool', has_shortcode('foo', 'foo'));
+
+assertType('false', has_shortcode('', ''));
+assertType('false', has_shortcode('', Faker::string()));
+assertType('false', has_shortcode(Faker::string(), ''));
+assertType('bool', has_shortcode(Faker::string(), Faker::string()));
+
+/*
+ * Check argument type
+ */
+
+$content = Faker::string();
+$tag = Faker::string();
+if (has_shortcode($content, $tag)) {
+    assertType('non-falsy-string', $content);
+    assertType('non-empty-string', $tag);
+}
+assertType('string', $content);
+assertType('string', $tag);
+
+// Check that types are not generalized
+$content = 'content';
+$tag = 'tag';
+if (has_shortcode($content, $tag)) {
+    assertType("'content'", $content);
+    assertType("'tag'", $tag);
+}

wordpress-stubs.php

@@ -137627,6 +137627,9 @@ function shortcode_exists($tag)
      * @param string $content Content to search for shortcodes.
      * @param string $tag     Shortcode tag to check.
      * @return bool Whether the passed content contains the given shortcode.
+     * @phpstan-assert-if-true =non-falsy-string $content
+     * @phpstan-assert-if-true =non-empty-string $tag
+     * @phpstan-return ($tag is empty ? false : ($content is empty ? false : bool))
      */
     function has_shortcode($content, $tag)
     {