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

Timestamp:

11/16/2020 11:02:32 AM (4 years ago)

Author:

johnbillion

Message:

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

See #50768

File:

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

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

@@ -131 +131 @@
  *                                          is 'null', the value cannot be set or updated. The function will be passed
  *                                          the model object, like WP_Post.
- *     @type array|null $schema             Optional. The callback function used to create the schema for this field.
+ *     @type array|null $schema             Optional. The schema for this field.
  *                                          Default is 'null', no schema entry will be returned.
  * }
@@ -154 +154 @@
 
 /**
- * Registers rewrite rules for the API.
+ * Registers rewrite rules for the REST API.
  *
  * @since 4.4.0
@@ -499 +499 @@
          * Filters the REST Server Class.
          *
-         * This filter allows you to adjust the server class used by the API, using a
+         * This filter allows you to adjust the server class used by the REST API, using a
          * different class to handle requests.
          *
@@ -510 +510 @@
 
         /**
-         * Fires when preparing to serve an API request.
+         * Fires when preparing to serve a REST API request.
          *
          * Endpoint objects should be created and register their hooks on this action rather
@@ -803 +803 @@
 
 /**
- * Filters the API response to include only a white-listed set of response object fields.
+ * Filters the REST API response to include only a white-listed set of response object fields.
  *
  * @since 4.8.0