Changeset 58704 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php

Timestamp:

07/10/2024 11:10:44 AM (22 months ago)

Author:

SergeyBiryukov

Message:

Docs: Correct @return values for a few REST API class methods.

Includes listing the expected type first, instead of WP_Error.

Follow-up to [39031], [39033], [46696], [49927], [49929], [50993], [51286], [51973], [52079], [52286], [53152], [56415].

Props antonvlasenko.
See #61593.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php (modified) (3 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php

@@ -78 +78 @@
      *
      * @param WP_REST_Request $request Full details about the request.
-     * @return WP_Error|bool True if the request has read access, WP_Error object otherwise.
+     * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
      */
     public function get_items_permissions_check( $request ) {
@@ -98 +98 @@
      *
      * @param WP_REST_Request $request Full details about the request.
-     * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.
+     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
      */
     public function get_items( $request ) {
@@ -141 +141 @@
      *
      * @param WP_REST_Request $request Full details about the request.
-     * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.
+     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
      */
     public function get_item( $request ) {