Changeset 43918 for branches/5.0/src/wp-includes/class-wp-block-type.php

Timestamp:

11/21/2018 02:43:33 PM (6 years ago)

Author:

danielbachhuber

Message:

REST API: Preserve unknown, respect null in server-side block rendering.

• Skips validation where there is no attribute definition, but keeps the attribute value. Previously, the attribute would be omitted from the attributes passed to render_callback. Notably, this resolves an issue where render_callback cannot receive a block's align and customClassName attribute values, since these are defined as a client-side filter.
• Validates null as a proper value in its own right. Previously, a client implementation of a block could track {"attribute":null} as an explicitly empty value, and the server would wrongly initiate defaulting behavior. The new behavior will now only populate a default value if the attribute is not defined at all, including when unset in its being invalid per the attribute schema.

Props aduth, noisysocks, youknowriad.
See #45145 for the patch, #45098 for the original ticket.

File:

• branches/5.0/src/wp-includes/class-wp-block-type.php (modified) (2 diffs)

branches/5.0/src/wp-includes/class-wp-block-type.php

@@ -124 +124 @@
     /**
      * Validates attributes against the current block schema, populating
-     * defaulted and missing values, and omitting unknown attributes.
+     * defaulted and missing values.
      *
      * @since 5.0.0
@@ -132 +132 @@
      */
     public function prepare_attributes_for_render( $attributes ) {
+        // If there are no attribute definitions for the block type, skip
+        // processing and return vebatim.
         if ( ! isset( $this->attributes ) ) {
             return $attributes;
         }
 
-        $prepared_attributes = array();
-
-        foreach ( $this->attributes as $attribute_name => $schema ) {
-            $value = null;
-
-            if ( isset( $attributes[ $attribute_name ] ) ) {
-                $is_valid = rest_validate_value_from_schema( $attributes[ $attribute_name ], $schema );
-                if ( ! is_wp_error( $is_valid ) ) {
-                    $value = rest_sanitize_value_from_schema( $attributes[ $attribute_name ], $schema );
-                }
+        foreach ( $attributes as $attribute_name => $value ) {
+            // If the attribute is not defined by the block type, it cannot be
+            // validated.
+            if ( ! isset( $this->attributes[ $attribute_name ] ) ) {
+                continue;
             }
 
-            if ( is_null( $value ) && isset( $schema['default'] ) ) {
-                $value = $schema['default'];
+            $schema = $this->attributes[ $attribute_name ];
+
+            // Validate value by JSON schema. An invalid value should revert to
+            // its default, if one exists. This occurs by virtue of the missing
+            // attributes loop immediately following. If there is not a default
+            // assigned, the attribute value should remain unset.
+            $is_valid = rest_validate_value_from_schema( $value, $schema );
+            if ( is_wp_error( $is_valid ) ) {
+                unset( $attributes[ $attribute_name ] );
             }
-
-            $prepared_attributes[ $attribute_name ] = $value;
-        }
-
-        return $prepared_attributes;
+        }
+
+        // Populate values of any missing attributes for which the block type
+        // defines a default.
+        $missing_schema_attributes = array_diff_key( $this->attributes, $attributes );
+        foreach ( $missing_schema_attributes as $attribute_name => $schema ) {
+            if ( isset( $schema['default'] ) ) {
+                $attributes[ $attribute_name ] = $schema['default'];
+            }
+        }
+
+        return $attributes;
     }