WordPress.org

Make WordPress Core


Ignore:
Timestamp:
11/16/2020 11:02:32 AM (11 months ago)
Author:
johnbillion
Message:

Docs: Corrections and improvements to inline docs relating to the REST API.

See #50768

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/rest-api/class-wp-rest-server.php

    r49257 r49610  
    260260
    261261    /**
    262      * Handles serving an API request.
     262     * Handles serving a REST API request.
    263263     *
    264264     * Matches the current server URI to a route and runs the first matching
     
    287287             * This is done because for authentications such as Application
    288288             * Passwords, we don't want it to be accepted unless the current HTTP
    289              * request is an API request, which can't always be identified early
     289             * request is a REST API request, which can't always be identified early
    290290             * enough in evaluation.
    291291             */
     
    368368         * @since 4.4.0
    369369         * @deprecated 4.7.0 Use the {@see 'rest_authentication_errors'} filter to
    370          *                   restrict access to the API.
     370         *                   restrict access to the REST API.
    371371         *
    372372         * @param bool $rest_enabled Whether the REST API is enabled. Default true.
     
    450450
    451451        /**
    452          * Filters the API response.
     452         * Filters the REST API response.
    453453         *
    454454         * Allows modification of the response before returning.
     
    457457         * @since 4.5.0 Applied to embedded responses.
    458458         *
    459          * @param WP_HTTP_Response $result  Result to send to the client. Usually a WP_REST_Response.
     459         * @param WP_HTTP_Response $result  Result to send to the client. Usually a `WP_REST_Response`.
    460460         * @param WP_REST_Server   $this    Server instance.
    461461         * @param WP_REST_Request  $request Request used to generate the response.
     
    476476
    477477        /**
    478          * Filters whether the request has already been served.
     478         * Filters whether the REST API request has already been served.
    479479         *
    480480         * Allow sending the request manually - by returning true, the API result
     
    485485         * @param bool             $served  Whether the request has already been served.
    486486         *                                           Default false.
    487          * @param WP_HTTP_Response $result  Result to send to the client. Usually a WP_REST_Response.
     487         * @param WP_HTTP_Response $result  Result to send to the client. Usually a `WP_REST_Response`.
    488488         * @param WP_REST_Request  $request Request used to generate the response.
    489489         * @param WP_REST_Server   $this    Server instance.
     
    501501
    502502            /**
    503              * Filters the API response.
     503             * Filters the REST API response.
    504504             *
    505505             * Allows modification of the response data after inserting
     
    12491249
    12501250        /**
    1251          * Filters the API root index data.
     1251         * Filters the REST API root index data.
    12521252         *
    12531253         * This contains the data describing the API. This includes information
Note: See TracChangeset for help on using the changeset viewer.