Fix wp_get_archives (#246)

Returns void even if echo is false
php-stubs · Oct 9, 2024 · 196099a · 196099a
1 parent 1484a81
commit 196099a
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/functionMap.php b/functionMap.php
@@ -59,7 +59,7 @@
     'wp_generate_tag_cloud' => ["(\$args is array{format: 'array'} ? array<int, string> : string)"],
     'wp_get_schedule' => [null, 'args' => $cronArgsType],
     'wp_get_scheduled_event' => [null, 'args' => $cronArgsType],
-    'wp_get_archives' => ['($args is array{echo: false|0} ? string : void)'],
+    'wp_get_archives' => ['($args is array{echo: false|0} ? string|void : void)'],
     'WP_Http::get' => [$httpReturnType],
     'WP_Http::head' => [$httpReturnType],
     'WP_Http::post' => [$httpReturnType],

diff --git a/tests/data/wp_get_archives.php b/tests/data/wp_get_archives.php
@@ -23,8 +23,8 @@
 assertType('null', wp_get_archives(['echo' => 1, 'key' => 'value']));
 
 // Explicit value of false|0
-assertType('string', wp_get_archives(['echo' => false, 'key' => 'value']));
-assertType('string', wp_get_archives(['echo' => 0, 'key' => 'value']));
+assertType('string|null', wp_get_archives(['echo' => false, 'key' => 'value']));
+assertType('string|null', wp_get_archives(['echo' => 0, 'key' => 'value']));
 
 // Unknown value
 assertType('string|null', wp_get_archives(['echo' => Faker::bool(), 'key' => 'value']));

diff --git a/wordpress-stubs.php b/wordpress-stubs.php
@@ -111994,7 +111994,7 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after =
      *   day?: string,
      *   w?: string,
      * } $args
-     * @phpstan-return ($args is array{echo: false|0} ? string : void)
+     * @phpstan-return ($args is array{echo: false|0} ? string|void : void)
      */
     function wp_get_archives($args = '')
     {