Changeset 47391 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

Timestamp:

02/28/2020 12:29:53 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for WP_REST_Attachments_Controller.

This adds a missing DocBlock for ::register_routes() and parameter descriptions for ::post_process_item().

Includes minor documenation fixes in other REST API classes for consistency.

Props dkarfa, mukesh27, SergeyBiryukov.
Fixes #48841.

File:

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

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

@@ -17 +17 @@
 class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
 
+    /**
+     * Registers the routes for attachments.
+     *
+     * @since 5.3.0
+     *
+     * @see register_rest_route()
+     */
     public function register_routes() {
         parent::register_routes();
@@ -345 +352 @@
      * @since 5.3.0
      *
-     * @param WP_REST_Request $request
-     * @return WP_REST_Response|WP_Error
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_REST_Response|WP_Error Response object on success, WP_Error object on failure.
      */
     public function post_process_item( $request ) {