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

Timestamp:

11/18/2021 01:48:43 PM (3 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-widgets-controller.php (modified) (2 diffs)

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

@@ -461 +461 @@
          * @since 5.8.0
          *
-         * @param string           $widget_id  ID of the widget marked for deletion.
-         * @param string           $sidebar_id ID of the sidebar the widget was deleted from.
-         * @param WP_REST_Response $response   The response data.
-         * @param WP_REST_Request  $request    The request sent to the API.
+         * @param string                    $widget_id  ID of the widget marked for deletion.
+         * @param string                    $sidebar_id ID of the sidebar the widget was deleted from.
+         * @param WP_REST_Response|WP_Error $response   The response data, or WP_Error object on failure.
+         * @param WP_REST_Request           $request    The request sent to the API.
          */
         do_action( 'rest_delete_widget', $widget_id, $sidebar_id, $response, $request );
@@ -734 +734 @@
          * @since 5.8.0
          *
-         * @param WP_REST_Response $response The response object.
-         * @param array            $widget   The registered widget data.
-         * @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 array                     $widget   The registered widget data.
+         * @param WP_REST_Request           $request  Request used to generate the response.
          */
         return apply_filters( 'rest_prepare_widget', $response, $widget, $request );