WordPress.org

Make WordPress Core

Changeset 37490


Ignore:
Timestamp:
05/22/2016 06:07:31 PM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize hook docs in wp-includes/rest-api/* to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

Location:
trunk/src/wp-includes/rest-api
Files:
3 edited

Legend:

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

    r37342 r37490  
    374374
    375375        /**
    376          * Filter the parameter order.
     376         * Filters the parameter order.
    377377         *
    378378         * The order affects which parameters are checked when using get_param() and family.
     
    971971
    972972        /**
    973          * Filter the request generated from a URL.
     973         * Filters the request generated from a URL.
    974974         *
    975975         * @since 4.5.0
  • trunk/src/wp-includes/rest-api/class-wp-rest-response.php

    r37431 r37490  
    276276
    277277        /**
    278          * Filter extra CURIEs available on API responses.
     278         * Filters extra CURIEs available on API responses.
    279279         *
    280280         * CURIEs allow a shortened version of URI relations. This allows a more
  • trunk/src/wp-includes/rest-api/class-wp-rest-server.php

    r37163 r37490  
    252252
    253253        /**
    254          * Filter whether the REST API is enabled.
     254         * Filters whether the REST API is enabled.
    255255         *
    256256         * @since 4.4.0
     
    261261
    262262        /**
    263          * Filter whether jsonp is enabled.
     263         * Filters whether jsonp is enabled.
    264264         *
    265265         * @since 4.4.0
     
    336336
    337337        /**
    338          * Filter the API response.
     338         * Filters the API response.
    339339         *
    340340         * Allows modification of the response before returning.
     
    362362
    363363        /**
    364          * Filter whether the request has already been served.
     364         * Filters whether the request has already been served.
    365365         *
    366366         * Allow sending the request manually - by returning true, the API result
     
    620620
    621621        /**
    622          * Filter the enveloped form of a response.
     622         * Filters the enveloped form of a response.
    623623         *
    624624         * @since 4.4.0
     
    700700
    701701        /**
    702          * Filter the array of available endpoints.
     702         * Filters the array of available endpoints.
    703703         *
    704704         * @since 4.4.0
     
    802802    public function dispatch( $request ) {
    803803        /**
    804          * Filter the pre-calculated result of a REST dispatch request.
     804         * Filters the pre-calculated result of a REST dispatch request.
    805805         *
    806806         * Allow hijacking the request before dispatching by returning a non-empty. The returned value
     
    887887                if ( ! is_wp_error( $response ) ) {
    888888                    /**
    889                      * Filter the REST dispatch request result.
     889                     * Filters the REST dispatch request result.
    890890                     *
    891891                     * Allow plugins to override dispatching the request.
     
    983983
    984984        /**
    985          * Filter the API root index data.
     985         * Filters the API root index data.
    986986         *
    987987         * This contains the data describing the API. This includes information
     
    10261026
    10271027        /**
    1028          * Filter the namespace index data.
     1028         * Filters the namespace index data.
    10291029         *
    10301030         * This typically is just the route data for the namespace, but you can
     
    10601060
    10611061            /**
    1062              * Filter the REST endpoint data.
     1062             * Filters the REST endpoint data.
    10631063             *
    10641064             * @since 4.4.0
     
    10701070
    10711071        /**
    1072          * Filter the publicly-visible data for routes.
     1072         * Filters the publicly-visible data for routes.
    10731073         *
    10741074         * This data is exposed on indexes and can be used by clients or
Note: See TracChangeset for help on using the changeset viewer.