path_join: narrow return type (#481)

Author: IanDelMar

functionMap.php

@@ -180,6 +180,7 @@
     'newblog_notify_siteadmin' => [null, 'deprecated' => "''"],
     'next_posts' => ['($display is true ? void : string)'],
     'paginate_links' => ["(\$args is array{total: int<min, 1>}&array ? void : (\$args is array{type: 'array'}&array ? list<string> : string))"],
+    'path_join' => ['non-falsy-string'],
     'post_type_archive_title' => ['($display is true ? void : string|void)'],
     'prep_atom_text_construct' => ["array{'html'|'text'|'xhtml', string}"],
     'previous_posts' => ['($display is true ? void : string)'],

tests/data/return/path-join.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpStubs\WordPress\Core\Tests;
+
+use function path_join;
+use function PHPStan\Testing\assertType;
+
+assertType('non-falsy-string', path_join('', ''));
+assertType('non-falsy-string', path_join('base', 'path'));
+assertType('non-falsy-string', path_join(Faker::string(), Faker::string()));

wordpress-stubs.php

@@ -130066,6 +130066,7 @@ function path_is_absolute($path)
      * @param string $base Base path.
      * @param string $path Path relative to $base.
      * @return string The path with the base or absolute path.
+     * @phpstan-return non-falsy-string
      */
     function path_join($base, $path)
     {