Changeset 58801 for trunk/tests/phpunit/tests/blocks/register.php

Timestamp:

07/24/2024 02:09:58 PM (7 weeks ago)

Author:

Bernhard Reiter

Message:

block.json: Allow passing PHP filename as variations field.

Previously, the variations field in a block.json file could be used to provide a static list of the block's variations (i.e., an array). Alternatively, the block's variation_callback could be set during server-side block registration to point to a PHP function to generate those variations.

This changeset makes it so that the block.json variations field can be alternatively set to a string, which will be interpreted as the filename of a PHP file that generates the variations.

It is loosely modeled after [54132], which introduced the render field for block.json, as a way to point to a PHP file instead of providing a render_callback.

Props bernhard-reiter, gziolo.
Fixes #61280.

File:

• trunk/tests/phpunit/tests/blocks/register.php (modified) (1 diff)

trunk/tests/phpunit/tests/blocks/register.php

@@ -959 +959 @@
 
     /**
+     * Tests registering a block with variations from a PHP file.
+     *
+     * @ticket 61280
+     *
+     * @covers ::register_block_type_from_metadata
+     */
+    public function test_register_block_type_from_metadata_with_variations_php_file() {
+        $filter_metadata_registration = static function ( $metadata ) {
+            $metadata['variations'] = 'file:./variations.php';
+            return $metadata;
+        };
+
+        add_filter( 'block_type_metadata', $filter_metadata_registration, 10, 2 );
+        $result = register_block_type_from_metadata(
+            DIR_TESTDATA . '/blocks/notice'
+        );
+        remove_filter( 'block_type_metadata', $filter_metadata_registration );
+
+        $this->assertInstanceOf( 'WP_Block_Type', $result, 'The block was not registered' );
+
+        $this->assertIsCallable( $result->variation_callback, 'The variation callback hasn\'t been set' );
+        $expected_variations = require DIR_TESTDATA . '/blocks/notice/variations.php';
+        $this->assertSame(
+            $expected_variations,
+            call_user_func( $result->variation_callback ),
+            'The variation callback hasn\'t been set correctly'
+        );
+        $this->assertSame( $expected_variations, $result->variations, 'The block variations are incorrect' );
+    }
+
+    /**
      * Tests that the function returns the registered block when the `block.json`
      * is found in the fixtures directory.