Changeset 34949 for trunk/src/wp-includes/rest-api/rest-functions.php

Timestamp:

10/08/2015 06:00:45 PM (10 years ago)

Author:

SergeyBiryukov

Message:

REST API: Add some missing documentation.

Props swissspidy.
Fixes #34215.

File:

• trunk/src/wp-includes/rest-api/rest-functions.php (modified) (9 diffs)

trunk/src/wp-includes/rest-api/rest-functions.php

@@ -5 +5 @@
  * @package WordPress
  * @subpackage REST_API
+ * @since 4.4.0
  */
 
@@ -11 +12 @@
  *
  * @since 4.4.0
+ *
+ * @global WP_REST_Server $wp_rest_server ResponseHandler instance (usually WP_REST_Server).
  *
  * @param string $namespace The first URL segment after core prefix. Should be unique to your package/plugin.
@@ -20 +23 @@
  */
 function register_rest_route( $namespace, $route, $args = array(), $override = false ) {
-
     /** @var WP_REST_Server $wp_rest_server */
     global $wp_rest_server;
@@ -68 +70 @@
  *
  * @param string|array $object_type Object(s) the field is being registered
- *                                   to, "post"|"term"|"comment" etc.
+ *                                  to, "post"|"term"|"comment" etc.
  * @param string $attribute         The attribute name.
  * @param array  $args {
@@ -79 +81 @@
  *                                              field value. Default is 'null', the value cannot be set or
  *                                              updated.
- *     @type string|array|null schema           Optional. The callback function used to create the schema for
+ *     @type string|array|null $schema          Optional. The callback function used to create the schema for
  *                                              this field. Default is 'null', no schema entry will be returned.
  * }
  */
 function register_api_field( $object_type, $attribute, $args = array() ) {
-
     $defaults = array(
         'get_callback'    => null,
@@ -154 +155 @@
  *
  * @since 4.4.0
+ *
+ * @global WP             $wp             Current WordPress environment instance.
+ * @global WP_REST_Server $wp_rest_server ResponseHandler instance (usually WP_REST_Server).
  */
 function rest_api_loaded() {
@@ -163 +167 @@
      * Whether this is a REST Request.
      *
+     * @since 4.4.0
      * @var bool
      */
@@ -287 +292 @@
  * @since 4.4.0
  *
- * @global WP_REST_Server $wp_rest_server
+ * @global WP_REST_Server $wp_rest_server ResponseHandler instance (usually WP_REST_Server).
  *
  * @param WP_REST_Request|string $request Request.
@@ -448 +453 @@
  */
 function rest_send_allow_header( $response, $server, $request ) {
-
     $matched_route = $response->get_matched_route();