register_block_type: Accept editor_script array for back-compat

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

@@ -295,15 +295,19 @@ public function __construct( $block_type, $args = array() ) {
 	 *
 	 * @param string $name Deprecated property name.
 	 *
-	 * @return string|null|void The value read from the new property if the first item in the array provided,
-	 *                          null when value not found, or void when unknown property name provided.
+	 * @return string|string[]|null|void The value read from the new property if the first item in the array provided,
+	 *                                   null when value not found, or void when unknown property name provided.
 	 */
 	public function __get( $name ) {
 		if ( ! in_array( $name, $this->deprecated_properties ) ) {
 			return;
 		}
 
 		$new_name = $name . '_handles';
+
+		if ( count( $this->{$new_name} ) > 1 ) {
+			return $this->{$new_name};
+		}
 		return isset( $this->{$new_name}[0] ) ? $this->{$new_name}[0] : null;
 	}
 
@@ -343,12 +347,32 @@ public function __set( $name, $value ) {
 			return;
 		}
 
+		$new_name = $name . '_handles';
+
+		if ( is_array( $value ) ) {
+			$filtered = array_filter( $value, 'is_string' );
+
+			if ( count( $filtered ) !== count( $value ) ) {
+					_doing_it_wrong(
+						__METHOD__,
+						sprintf(
+							/* translators: %s: The '$value' argument. */
+							__( 'The %s argument must be a string or a string array.' ),
+							'<code>$value</code>'
+						),
+						'6.1.0'
+					);
+			}
+
+			$this->{$new_name} = array_values( $filtered );
+			return;
+		}
+
 		if ( ! is_string( $value ) ) {
 			return;
 		}
 
-		$new_name             = $name . '_handles';
-		$this->{$new_name}[0] = $value;
+		$this->{$new_name} = array( $value );
 	}
 
 	/**

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

@@ -295,6 +295,10 @@ public function prepare_item_for_response( $item, $request ) {
 			if ( rest_is_field_included( $extra_field, $fields ) ) {
 				if ( isset( $block_type->$extra_field ) ) {
 					$field = $block_type->$extra_field;
+					if ( in_array( $extra_field, $deprecated_fields, true ) && is_array( $field ) ) {
+						// Since the schema only allows strings or null (but no arrays), we return the first array item.
+						$field = isset( $field[0] ) ? $field[0] : null;
+					}
 				} elseif ( array_key_exists( 'default', $schema['properties'][ $extra_field ] ) ) {
 					$field = $schema['properties'][ $extra_field ]['default'];
 				} else {

tests/phpunit/tests/blocks/register.php

@@ -552,6 +552,132 @@ public function test_block_register_block_type_proxy_for_metadata() {
 		$this->assertSame( 'tests/notice', $result->name );
 	}
 
+	/**
+	 * Tests that an array value for 'editor_script' is correctly set and retrieved.
+	 *
+	 * As 'editor_script' is now a deprecated property, this should also set
+	 * the value for the 'editor_script_handles' property.
+	 *
+	 * @ticket 56707
+	 *
+	 * @covers ::register_block_type
+	 * @covers WP_Block_Type::__set
+	 * @covers WP_Block_Type::__get
+	 *
+	 * @dataProvider data_register_block_type_accepts_editor_script_array
+	 *
+	 * @param array $editor_script The editor script array to register.
+	 * @param array $expected      The expected registered editor script.
+	 */
+	public function test_register_block_type_accepts_editor_script_array( $editor_script, $expected ) {
+		$settings = array( 'editor_script' => $editor_script );
+		register_block_type( 'core/test-static', $settings );
+
+		$registry              = WP_Block_Type_Registry::get_instance();
+		$block_type            = $registry->get_registered('core/test-static');
+		$actual_script         = $block_type->editor_script;
+		$actual_script_handles = $block_type->editor_script_handles;
+
+		$this->assertSame(
+			$expected,
+			$actual_script,
+			'editor_script was not set to the correct value.'
+		);
+
+		$this->assertSame(
+			(array) $expected,
+			$actual_script_handles,
+			'editor_script_handles was not set to the correct value.'
+		);
+	}
+
+	/**
+	 * Data provider for test_register_block_type_accepts_editor_script_array().
+	 *
+	 * @return array
+	 */
+	public function data_register_block_type_accepts_editor_script_array() {
+		return array(
+			'an empty array'      => array(
+				'editor_script' => array(),
+				'expected'      => null,
+			),
+			'a single item array' => array(
+				'editor_script' => array( 'hello' ),
+				'expected'      => 'hello',
+			),
+			'a multi-item array'  => array(
+				'editor_script' => array( 'hello', 'world' ),
+				'expected'      => array( 'hello', 'world' ),
+			),
+		);
+	}
+
+	/**
+	 * Tests that an array value for 'editor_script' containing invalid values
+	 * correctly triggers _doing_it_wrong(), filters the value, and sets the
+	 * property to the result.
+	 *
+	 * As 'editor_script' is now a deprecated property, this should also set
+	 * the value for the 'editor_script_handles' property.
+	 *
+	 * @ticket 56707
+	 *
+	 * @covers ::register_block_type
+	 * @covers WP_Block_Type::__set
+	 * @covers WP_Block_Type::__get
+	 *
+	 * @dataProvider data_register_block_type_throws_doing_it_wrong
+	 *
+	 * @expectedIncorrectUsage WP_Block_Type::__set
+	 *
+	 * @param array $editor_script The editor script array to register.
+	 * @param array $expected      The expected registered editor script.
+	 */
+	public function test_register_block_type_throws_doing_it_wrong( $editor_script, $expected ) {
+		$settings = array( 'editor_script' => $editor_script );
+		register_block_type( 'core/test-static', $settings );
+
+		$registry              = WP_Block_Type_Registry::get_instance();
+		$block_type            = $registry->get_registered('core/test-static');
+		$actual_script         = $block_type->editor_script;
+		$actual_script_handles = $block_type->editor_script_handles;
+
+		$this->assertSame(
+			$expected,
+			$actual_script,
+			'editor_script was not set to the correct value.'
+		);
+
+		$this->assertSame(
+			(array) $expected,
+			$actual_script_handles,
+			'editor_script_handles was not set to the correct value.'
+		);
+	}
+
+	/**
+	 * Data provider for test_register_block_type_throws_doing_it_wrong().
+	 *
+	 * @return array
+	 */
+	public function data_register_block_type_throws_doing_it_wrong() {
+		return array(
+			'a non-string array'     => array(
+				'editor_script' => array( null, false, true, -1, 0, 1, -1.0, 0.0, 1.0, INF, NAN, new stdClass() ),
+				'expected'      => null,
+			),
+			'a partial string array' => array(
+				'editor_script' => array( null, false, 'script.js', true, 0, 'actions.js', 1, INF ),
+				'expected'      => array( 'script.js', 'actions.js' ),
+			),
+			'a partial string array that results in one item with non-zero index' => array(
+				'editor_script' => array( null, false, 'script.js' ),
+				'expected'      => 'script.js',
+			),
+		);
+	}
+
 	/**
 	 * @ticket 52301
 	 */

tests/phpunit/tests/rest-api/rest-block-type-controller.php

@@ -338,6 +338,67 @@ public function test_get_item_defaults() {
 		$this->assertNull( $data['style'] );
 	}
 
+	/**
+	 * @ticket 56733
+	 */
+	public function test_get_item_deprecated() {
+		$block_type = 'fake/deprecated';
+		$settings   = array(
+			'editor_script' => 'hello_world',
+			'script'        => 'gutenberg',
+			'view_script'   => 'foo_bar',
+			'editor_style'  => 'guten_tag',
+			'style'         => 'out_of_style',
+		);
+		register_block_type( $block_type, $settings );
+		wp_set_current_user( self::$admin_id );
+		$request  = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_type );
+		$response = rest_get_server()->dispatch( $request );
+		$data     = $response->get_data();
+		$this->assertSameSets( array( 'hello_world' ), $data['editor_script_handles'] );
+		$this->assertSameSets( array( 'gutenberg' ), $data['script_handles'] );
+		$this->assertSameSets( array( 'foo_bar' ), $data['view_script_handles'] );
+		$this->assertSameSets( array( 'guten_tag' ), $data['editor_style_handles'] );
+		$this->assertSameSets( array( 'out_of_style' ), $data['style_handles'] );
+		// Deprecated properties.
+		$this->assertSame( 'hello_world', $data['editor_script'] );
+		$this->assertSame( 'gutenberg', $data['script'] );
+		$this->assertSame( 'foo_bar', $data['view_script'] );
+		$this->assertSame( 'guten_tag', $data['editor_style'] );
+		$this->assertSame( 'out_of_style', $data['style'] );
+	}
+
+	/**
+	 * @ticket 56733
+	 */
+	public function test_get_item_deprecated_with_arrays() {
+		$block_type = 'fake/deprecated-with-arrays';
+		$settings   = array(
+			'editor_script' => array( 'hello', 'world' ),
+			'script'        => array( 'gutenberg' ),
+			'view_script'   => array( 'foo', 'bar' ),
+			'editor_style'  => array( 'guten', 'tag' ),
+			'style'         => array( 'out', 'of', 'style' ),
+		);
+		register_block_type( $block_type, $settings );
+		wp_set_current_user( self::$admin_id );
+		$request  = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_type );
+		$response = rest_get_server()->dispatch( $request );
+		$data     = $response->get_data();
+		$this->assertSameSets( $settings['editor_script'], $data['editor_script_handles'] );
+		$this->assertSameSets( $settings['script'], $data['script_handles'] );
+		$this->assertSameSets( $settings['view_script'], $data['view_script_handles'] );
+		$this->assertSameSets( $settings['editor_style'], $data['editor_style_handles'] );
+		$this->assertSameSets( $settings['style'], $data['style_handles'] );
+		// Deprecated properties.
+		// Since the schema only allows strings or null (but no arrays), we return the first array item.
+		$this->assertSame( 'hello', $data['editor_script'] );
+		$this->assertSame( 'gutenberg', $data['script'] );
+		$this->assertSame( 'foo', $data['view_script'] );
+		$this->assertSame( 'guten', $data['editor_style'] );
+		$this->assertSame( 'out', $data['style'] );
+	}
+
 	public function test_get_variation() {
 		$block_type = 'fake/variations';
 		$settings   = array(