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

Timestamp:

05/16/2020 06:41:41 PM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Check required properties are provided when validating an object.

Previously, the WP_REST_Request object validated that top-level properties were defined, but this did not extend to those object's required properties. This adds validation to rest_validate_value_from_schema() directly.

Both the v3 and v4 JSON Schema syntax for required properties is supported.

Props sorenbronsted.
Fixes #48818.

File:

• trunk/src/wp-includes/rest-api.php (modified) (1 diff)

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

@@ -1283 +1283 @@
             /* translators: 1: Parameter, 2: Type name. */
             return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'object' ) );
+        }
+
+        if ( isset( $args['required'] ) && is_array( $args['required'] ) ) { // schema version 4
+            foreach ( $args['required'] as $name ) {
+                if ( ! array_key_exists( $name, $value ) ) {
+                    /* translators: 1: Property of an object, 2: Parameter. */
+                    return new WP_Error( 'rest_property_required', sprintf( __( '%1$s is a required property of %2$s.' ), $name, $param ) );
+                }
+            }
+        } elseif ( isset( $args['properties'] ) ) { // schema version 3
+            foreach ( $args['properties'] as $name => $property ) {
+                if ( isset( $property['required'] ) && true === $property['required'] && ! array_key_exists( $name, $value ) ) {
+                    /* translators: 1: Property of an object, 2: Parameter. */
+                    return new WP_Error( 'rest_property_required', sprintf( __( '%1$s is a required property of %2$s.' ), $name, $param ) );
+                }
+            }
         }