Changeset 45810

Timestamp:

08/15/2019 08:03:18 PM (6 years ago)

Author:

kadamwhite

Message:

REST API: Clarify arguments passed to rest route get & update callbacks.

Update doc block argument definitions to clarify that the REST API always passes an array to the get_callback and always passes an entity object to the update_callback.

Props TimothyBlynJacobs, salzano.
Fixes #44432.

Location:

trunk/src/wp-includes

Files:

• rest-api.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-controller.php (modified) (3 diffs)

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

@@ -103 +103 @@
  *     Optional. An array of arguments used to handle the registered field.
  *
- *     @type string|array|null $get_callback    Optional. The callback function used to retrieve the field
- *                                              value. Default is 'null', the field will not be returned in
- *                                              the response.
- *     @type string|array|null $update_callback Optional. The callback function used to set and update the
- *                                              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
- *                                              this field. Default is 'null', no schema entry will be returned.
+ *     @type callable|null $get_callback    Optional. The callback function used to retrieve the field value. Default is
+ *                                          'null', the field will not be returned in the response. The function will
+ *                                          be passed the prepared object data.
+ *     @type callable|null $update_callback Optional. The callback function used to set and update the field value. Default
+ *                                          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.
+ *                                          Default is 'null', no schema entry will be returned.
  * }
  */

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php

@@ -373 +373 @@
      * @since 4.7.0
      *
-     * @param array           $object  Data object.
-     * @param WP_REST_Request $request Full details about the request.
+     * @param array           $prepared Prepared response array.
+     * @param WP_REST_Request $request  Full details about the request.
      * @return array Modified data object with additional fields.
      */
-    protected function add_additional_fields_to_object( $object, $request ) {
+    protected function add_additional_fields_to_object( $prepared, $request ) {
 
         $additional_fields = $this->get_additional_fields();
@@ -393 +393 @@
             }
 
-            $object[ $field_name ] = call_user_func( $field_options['get_callback'], $object, $field_name, $request, $this->get_object_type() );
-        }
-
-        return $object;
+            $prepared[ $field_name ] = call_user_func( $field_options['get_callback'], $prepared, $field_name, $request, $this->get_object_type() );
+        }
+
+        return $prepared;
     }
 
@@ -404 +404 @@
      * @since 4.7.0
      *
-     * @param array           $object  Data Object.
+     * @param object          $object  Data model like WP_Term or WP_Post.
      * @param WP_REST_Request $request Full details about the request.
      * @return bool|WP_Error True on success, WP_Error object if a field cannot be updated.