WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
02/28/2020 12:29:53 PM (7 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:
1 edited

Legend:

Unmodified
Added
Removed

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

    r47233 r47391  
    6262
    6363        /**
    64          * Registers routes for revisions based on post types supporting revisions.
     64         * Registers the routes for revisions based on post types supporting revisions.
    6565         *
    6666         * @since 4.7.0
    … …  
    161161         * @since 4.7.0
    162162         *
    163          * @param WP_REST_Request $request Full data about the request.
     163         * @param WP_REST_Request $request Full details about the request.
    164164         * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
    165165         */
    … …  
    215215         * @since 4.7.0
    216216         *
    217          * @param WP_REST_Request $request Full data about the request.
     217         * @param WP_REST_Request $request Full details about the request.
    218218         * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
    219219         */
    … …  
    364364         * @since 4.7.0
    365365         *
    366          * @param WP_REST_Request $request Full data about the request.
     366         * @param WP_REST_Request $request Full details about the request.
    367367         * @return bool|WP_Error True if the request has read access for the item, WP_Error object otherwise.
    368368         */
    … …  
    376376         * @since 4.7.0
    377377         *
    378          * @param WP_REST_Request $request Full data about the request.
     378         * @param WP_REST_Request $request Full details about the request.
    379379         * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
    380380         */
Note: See TracChangeset for help on using the changeset viewer.