Set conditional return type for rest_ensure_response (#177)

php-stubs · May 15, 2024 · cd5f253 · cd5f253
1 parent 86b646c
commit cd5f253
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/functionMap.php b/functionMap.php
@@ -59,6 +59,7 @@
     'wp_unschedule_event' => ['($wp_error is false ? bool : true|\WP_Error)', 'args' => $cronArgsType],
     'wp_unslash' => ['T', '@phpstan-template' => 'T', 'value' => 'T'],
     'wp_widget_rss_form' => ['void', 'args' => $wpWidgetRssFormArgsType, 'inputs' => $wpWidgetRssFormInputsType],
+    'rest_ensure_response' => ['($response is WP_Error ? WP_Error : WP_REST_Response)'],
     'WP_REST_Request' => [null, '@phpstan-template' => 'T of array', '@phpstan-implements' => 'ArrayAccess<key-of<T>, value-of<T>>'],
     'WP_REST_Request::offsetExists' => [null, 'offset' => 'key-of<T>'],
     'WP_REST_Request::offsetGet' => ['T[TOffset]', '@phpstan-template' => 'TOffset of key-of<T>', 'offset' => 'TOffset'],

diff --git a/tests/TypeInferenceTest.php b/tests/TypeInferenceTest.php
@@ -33,6 +33,7 @@ public function dataFileAsserts(): iterable
         yield from $this->gatherAssertTypes(__DIR__ . '/data/wp_error_parameter.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/wp_theme.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/wpdb.php');
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/rest_ensure_response.php');
     }
 
     /**

diff --git a/tests/data/rest_ensure_response.php b/tests/data/rest_ensure_response.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpStubs\WordPress\Core\Tests;
+
+use WP_Error;
+use WP_REST_Response;
+use function get_term;
+use function PHPStan\Testing\assertType;
+
+assertType('WP_Error', rest_ensure_response(new WP_Error()));
+assertType('WP_REST_Response', rest_ensure_response([]));
+assertType('WP_REST_Response', rest_ensure_response(new WP_REST_Response()));
diff --git a/wordpress-stubs.php b/wordpress-stubs.php
@@ -134212,6 +134212,7 @@ function rest_ensure_request($request)
      * @return WP_REST_Response|WP_Error If response generated an error, WP_Error, if response
      *                                   is already an instance, WP_REST_Response, otherwise
      *                                   returns a new WP_REST_Response instance.
+     * @phpstan-return ($response is WP_Error ? WP_Error : WP_REST_Response)
      */
     function rest_ensure_response($response)
     {