IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
- 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, danielbachhuber.

Merges [43918] to trunk.

See #45145 for the patch, #45098 for the original ticket.
Built from https://develop.svn.wordpress.org/trunk@44269


git-svn-id: http://core.svn.wordpress.org/trunk@44099 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
desrosj
2018-12-17 18:00:52 +00:00
parent f2b97f3c7f
commit bc9dfcfeb1
3 changed files with 29 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
wp-includes/class-wp-block-type.php
View File

@@ -123,7 +123,7 @@ class WP_Block_Type {
/** /**
* Validates attributes against the current block schema, populating * Validates attributes against the current block schema, populating
* defaulted and missing values, and omitting unknown attributes. * defaulted and missing values.
* *
* @since 5.0.0 * @since 5.0.0
* *
@@ -131,30 +131,41 @@ class WP_Block_Type {
* @return array Prepared block attributes. * @return array Prepared block attributes.
*/ */
public function prepare_attributes_for_render( $attributes ) { 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 ) ) { if ( ! isset( $this->attributes ) ) {
return $attributes; return $attributes;
} }
$prepared_attributes = array(); 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;
}
foreach ( $this->attributes as $attribute_name => $schema ) { $schema = $this->attributes[ $attribute_name ];
$value = null;
if ( isset( $attributes[ $attribute_name ] ) ) { // Validate value by JSON schema. An invalid value should revert to
$is_valid = rest_validate_value_from_schema( $attributes[ $attribute_name ], $schema ); // its default, if one exists. This occurs by virtue of the missing
if ( ! is_wp_error( $is_valid ) ) { // attributes loop immediately following. If there is not a default
$value = rest_sanitize_value_from_schema( $attributes[ $attribute_name ], $schema ); // 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 ] );
} }
} }
if ( is_null( $value ) && isset( $schema['default'] ) ) { // Populate values of any missing attributes for which the block type
$value = $schema['default']; // 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'];
}
} }
$prepared_attributes[ $attribute_name ] = $value; return $attributes;
}
return $prepared_attributes;
} }
/** /**

1
wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php
View File

@@ -61,6 +61,7 @@ class WP_REST_Block_Renderer_Controller extends WP_REST_Controller {
'type' => 'object', 'type' => 'object',
'additionalProperties' => false, 'additionalProperties' => false,
'properties' => $block_type->get_attributes(), 'properties' => $block_type->get_attributes(),
'default' => array(),
), ),
'post_id' => array( 'post_id' => array(
'description' => __( 'ID of the post context.' ), 'description' => __( 'ID of the post context.' ),

2
wp-includes/version.php
View File

@@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.1-alpha-44268'; $wp_version = '5.1-alpha-44269';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.