sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

See #36913.


git-svn-id: https://develop.svn.wordpress.org/trunk@37490 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-05-22 18:07:31 +00:00
parent 8fe11fa642
commit 0aa4ec76ab
3 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/wp-includes/rest-api/class-wp-rest-request.php
View File

@ -373,7 +373,7 @@ class WP_REST_Request implements ArrayAccess {
$order[] = 'defaults'; $order[] = 'defaults';
/** /**
* Filter the parameter order. * Filters the parameter order.
* *
* The order affects which parameters are checked when using get_param() and family. * The order affects which parameters are checked when using get_param() and family.
* This acts similarly to PHP's `request_order` setting. * This acts similarly to PHP's `request_order` setting.
@ -970,7 +970,7 @@ class WP_REST_Request implements ArrayAccess {
} }
/** /**
* Filter the request generated from a URL. * Filters the request generated from a URL.
* *
* @since 4.5.0 * @since 4.5.0
* *

2
src/wp-includes/rest-api/class-wp-rest-response.php
View File

@ -275,7 +275,7 @@ class WP_REST_Response extends WP_HTTP_Response {
); );
/** /**
* Filter extra CURIEs available on API responses. * Filters extra CURIEs available on API responses.
* *
* CURIEs allow a shortened version of URI relations. This allows a more * CURIEs allow a shortened version of URI relations. This allows a more
* usable form for custom relations than using the full URI. These work * usable form for custom relations than using the full URI. These work

24
src/wp-includes/rest-api/class-wp-rest-server.php
View File

@ -251,7 +251,7 @@ class WP_REST_Server {
} }
/** /**
* Filter whether the REST API is enabled. * Filters whether the REST API is enabled.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -260,7 +260,7 @@ class WP_REST_Server {
$enabled = apply_filters( 'rest_enabled', true ); $enabled = apply_filters( 'rest_enabled', true );
/** /**
* Filter whether jsonp is enabled. * Filters whether jsonp is enabled.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -335,7 +335,7 @@ class WP_REST_Server {
} }
/** /**
* Filter the API response. * Filters the API response.
* *
* Allows modification of the response before returning. * Allows modification of the response before returning.
* *
@ -361,7 +361,7 @@ class WP_REST_Server {
$this->set_status( $code ); $this->set_status( $code );
/** /**
* Filter whether the request has already been served. * Filters whether the request has already been served.
* *
* Allow sending the request manually - by returning true, the API result * Allow sending the request manually - by returning true, the API result
* will not be sent to the client. * will not be sent to the client.
@ -619,7 +619,7 @@ class WP_REST_Server {
); );
/** /**
* Filter the enveloped form of a response. * Filters the enveloped form of a response.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -699,7 +699,7 @@ class WP_REST_Server {
public function get_routes() { public function get_routes() {
/** /**
* Filter the array of available endpoints. * Filters the array of available endpoints.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -801,7 +801,7 @@ class WP_REST_Server {
*/ */
public function dispatch( $request ) { public function dispatch( $request ) {
/** /**
* Filter the pre-calculated result of a REST dispatch request. * Filters the pre-calculated result of a REST dispatch request.
* *
* Allow hijacking the request before dispatching by returning a non-empty. The returned value * Allow hijacking the request before dispatching by returning a non-empty. The returned value
* will be used to serve the request instead. * will be used to serve the request instead.
@ -886,7 +886,7 @@ class WP_REST_Server {
if ( ! is_wp_error( $response ) ) { if ( ! is_wp_error( $response ) ) {
/** /**
* Filter the REST dispatch request result. * Filters the REST dispatch request result.
* *
* Allow plugins to override dispatching the request. * Allow plugins to override dispatching the request.
* *
@ -982,7 +982,7 @@ class WP_REST_Server {
$response->add_link( 'help', 'http://v2.wp-api.org/' ); $response->add_link( 'help', 'http://v2.wp-api.org/' );
/** /**
* Filter the API root index data. * Filters the API root index data.
* *
* This contains the data describing the API. This includes information * This contains the data describing the API. This includes information
* about supported authentication schemes, supported namespaces, routes * about supported authentication schemes, supported namespaces, routes
@ -1025,7 +1025,7 @@ class WP_REST_Server {
$response->add_link( 'up', rest_url( '/' ) ); $response->add_link( 'up', rest_url( '/' ) );
/** /**
* Filter the namespace index data. * Filters the namespace index data.
* *
* This typically is just the route data for the namespace, but you can * This typically is just the route data for the namespace, but you can
* add any data you'd like here. * add any data you'd like here.
@ -1059,7 +1059,7 @@ class WP_REST_Server {
} }
/** /**
* Filter the REST endpoint data. * Filters the REST endpoint data.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -1069,7 +1069,7 @@ class WP_REST_Server {
} }
/** /**
* Filter the publicly-visible data for routes. * Filters the publicly-visible data for routes.
* *
* This data is exposed on indexes and can be used by clients or * This data is exposed on indexes and can be used by clients or
* developers to investigate the site and find out how to use it. It * developers to investigate the site and find out how to use it. It