Changeset 52204 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-navigation-areas-controller.php

Timestamp:

11/18/2021 01:48:43 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Various corrections and improvements relating to types used in inline documentation.

See #53399

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-navigation-areas-controller.php (modified) (2 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-navigation-areas-controller.php

@@ -212 +212 @@
      * @param stdClass        $area    Post status data.
      * @param WP_REST_Request $request Full details about the request.
-     * @return WP_REST_Response Post status data.
+     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
      */
     public function prepare_item_for_response( $area, $request ) {
@@ -247 +247 @@
          * returned.
          *
-         * @param WP_REST_Response $response The response object.
-         * @param object           $area     The original status object.
-         * @param WP_REST_Request  $request  Request used to generate the response.
+         * @param WP_REST_Response\WP_Error $response The response object, or WP_Error object on failure.
+         * @param object                    $area     The original status object.
+         * @param WP_REST_Request           $request  Request used to generate the response.
          */
         return apply_filters( 'rest_prepare_navigation_area', $response, $area, $request );