Add cond. return type for size_format() (#208)

functionMap.php

@@ -159,4 +159,5 @@
     'WP_Widget::widget' => [null, 'instance' => 'T', 'args' => 'array{name:string,id:string,description:string,class:string,before_widget:string,after_widget:string,before_title:string,after_title:string,before_sidebar:string,after_sidebar:string,show_in_rest:boolean,widget_id:string,widget_name:string}'],
     'wp_parse_list' => ['($input_list is array ? array<scalar> : list<string>)'],
     'wp_parse_str' => [null, '@phpstan-param-out' => 'array<int|string, array|string> $result'],
+    'size_format' => ["(\$bytes is not numeric ? false : (\$bytes is negative-int|'0' ? false : string))"],
 ];

tests/TypeInferenceTest.php

@@ -31,6 +31,7 @@ public function dataFileAsserts(): iterable
         yield from $this->gatherAssertTypes(__DIR__ . '/data/is_wp_error.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/mysql2date.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/rest_ensure_response.php');
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/size_format.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/term_exists.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/wp_debug_backtrace_summary.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/wp_die.php');

tests/data/size_format.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpStubs\WordPress\Core\Tests;
+
+use function PHPStan\Testing\assertType;
+use function size_format;
+
+assertType('string', size_format(123));
+assertType('string', size_format('123'));
+assertType('string', size_format('123.1'));
+assertType('string', size_format(0));
+assertType('false', size_format('0'));
+assertType('false', size_format('string'));

wordpress-stubs.php

@@ -112766,6 +112766,7 @@ function number_format_i18n($number, $decimals = 0)
      * @param int|string $bytes    Number of bytes. Note max integer size for integers.
      * @param int        $decimals Optional. Precision of number of decimal places. Default 0.
      * @return string|false Number string on success, false on failure.
+     * @phpstan-return ($bytes is not numeric ? false : ($bytes is negative-int|'0' ? false : string))
      */
     function size_format($bytes, $decimals = 0)
     {