Merge pull request #78 from WP-API/danielbachhuber-patch-1

Rename `register_api_field()` to `register_rest_field()` in docs

Author: danielbachhuber

extending/modifying/index.md

@@ -3,13 +3,13 @@ title: Modifying Responses
 ---
 The default endpoints of the WordPress REST API are designed to be sensible defaults in terms of what data is returned. This fits the 80/20 rule by providing for 80% of sites and uses, but these default collections of data cannot always fulfill the needs of every one of the millions of sites.
 
-The REST API is designed to be highly extensible, like the rest (no pun intended) of WordPress. This document details how to add additional data, including but not limited to post or user meta data to the responses of default endpoints, using the function `register_api_field`; a helper function designed to add fields to the response for a specific option.
+The REST API is designed to be highly extensible, like the rest (no pun intended) of WordPress. This document details how to add additional data, including but not limited to post or user meta data to the responses of default endpoints, using the function `register_rest_field`; a helper function designed to add fields to the response for a specific option.
 
-`register_api_field` provides a single way for modifying all responses for an object. For example, if it is used to add a field to the posts object, this field will be included in all responses, whether they are for single or multiple items.
+`register_rest_field` provides a single way for modifying all responses for an object. For example, if it is used to add a field to the posts object, this field will be included in all responses, whether they are for single or multiple items.
 
 In addition, it allows you to update that value from the endpoints the field is registered on.
 
-It is important to note that in the context of this document, the term "field" refers to a field in the object returned by the API. It does not refer to a meta field of a post, comment or user. While it `register_api_field` can be used to add meta fields to a response, it can be used to add any data.
+It is important to note that in the context of this document, the term "field" refers to a field in the object returned by the API. It does not refer to a meta field of a post, comment or user. While it `register_rest_field` can be used to add meta fields to a response, it can be used to add any data.
 
 
 Important Note about Changing Responses
@@ -24,18 +24,18 @@ Adding fields is not dangerous, so if you need to modify data, it's much better
 Note that the API cannot prevent you from changing responses, but the code is structured to strongly discourage this. Internally, field registration is powered by filters, and these can be used if you absolutely have no other choice.
 
 
-What `register_api_field` Does
+What `register_rest_field` Does
 ------------------------------
 
-In the infrastructure for responses, the global variable $wp_rest_additional_fields, is used for holding the fields, by object name to be added to the responses to those objects. The REST API provides `register_api_field` as a utility function for adding to this global variable. Adding to it directly should be avoided to ensure maximum forward-compatibility.
+In the infrastructure for responses, the global variable $wp_rest_additional_fields, is used for holding the fields, by object name to be added to the responses to those objects. The REST API provides `register_rest_field` as a utility function for adding to this global variable. Adding to it directly should be avoided to ensure maximum forward-compatibility.
 
 For each object -- a post type, or users, terms, comments, meta, etc, $wp_rest_additional_fields contains an array of fields, each of which can have a value for callbacks used to retrieve the value, update the value using any endpoint that field is added to that can be used for updating.
 
 
-How To Use `register_api_field`
+How To Use `register_rest_field`
 -------------------------------
 
-The function `register_api_field` field accepts three parameters:
+The function `register_rest_field` field accepts three parameters:
 
 1. `$object_type`: The name of the object, as a string, or an array of the names of objects the field is being registered to. When adding to posts type endpoints, the name of the post type(s) should be used. Alternatively "terms", "meta", "user" or "comments" may be used.
 
@@ -57,7 +57,7 @@ Examples
 <?php
 add_action( 'rest_api_init', 'slug_register_starship' );
 function slug_register_starship() {
-    register_api_field( 'post',
+    register_rest_field( 'post',
         'starship',
         array(
             'get_callback'    => 'slug_get_starship',
@@ -92,7 +92,7 @@ This example illustrates adding the post meta field "starship" to the response f
  */
 add_action( 'rest_api_init', 'slug_register_spaceship' );
 function slug_register_spaceship() {
-    register_api_field( 'post',
+    register_rest_field( 'post',
         'starship',
         array(
             'get_callback'    => 'slug_get_spaceship',
@@ -148,7 +148,7 @@ This example shows how to allow reading and writing of a post meta field. This w
  */
 add_action( 'rest_api_init', 'slug_register_something_random' );
 function slug_register_starship() {
-    register_api_field( 'post',
+    register_rest_field( 'post',
         'something',
         array(
             'get_callback'    => 'slug_get_something',