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

Timestamp:

10/04/2017 08:26:44 AM (7 years ago)

Author:

joehoyle

Message:

REST API: Support for objects in schema validation and sanitization.

When registering routes developers can now define their complex objects in the schema and benefit from the automatic validation and sanitization in the REST API. This also paves the way for support for complex object registration via register_meta and register_setting.

See #38583.
Props TimothyBlynJacobs5.

File:

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

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

@@ -1052 +1052 @@
         }
     }
+
+    if ( 'object' === $args['type'] ) {
+        if ( $value instanceof stdClass ) {
+            $value = (array) $value;
+        }
+        if ( ! is_array( $value ) ) {
+            /* translators: 1: parameter, 2: type name */
+            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'object' ) );
+        }
+
+        foreach ( $value as $property => $v ) {
+            if ( ! isset( $args['properties'][ $property ] ) ) {
+                continue;
+            }
+            $is_valid = rest_validate_value_from_schema( $v, $args['properties'][ $property ], $param . '[' . $property . ']' );
+
+            if ( is_wp_error( $is_valid ) ) {
+                return $is_valid;
+            }
+        }
+    }
+
     if ( ! empty( $args['enum'] ) ) {
         if ( ! in_array( $value, $args['enum'], true ) ) {
@@ -1171 +1193 @@
         return $value;
     }
+
+    if ( 'object' === $args['type'] ) {
+        if ( $value instanceof stdClass ) {
+            $value = (array) $value;
+        }
+        if ( ! is_array( $value ) ) {
+            return array();
+        }
+
+        foreach ( $value as $property => $v ) {
+            if ( ! isset( $args['properties'][ $property ] ) ) {
+                unset( $value[ $property ] );
+                continue;
+            }
+            $value[ $property ] = rest_sanitize_value_from_schema( $v, $args['properties'][ $property ] );
+        }
+
+        return $value;
+    }
+
     if ( 'integer' === $args['type'] ) {
         return (int) $value;