Changeset 57315 for trunk/tests/phpunit/tests/rest-api/rest-block-type-controller.php

Timestamp:

01/19/2024 08:52:06 PM (17 months ago)

Author:

joemcgill

Message:

Editor: Support deferred block variation initialization on the server.

When registering blocks on the server using register_block_type() or similar functions, a set of block type variations can also be registered. However, in some cases building this variation data during block registration can be an expensive process, which is not needed in most contexts.

To address this problem, this adds support to the WP_Block_Type object for a new property, variation_callback, which can be used to register a callback for building variation data only when the block variations data is needed. The WP_Block_Type::variations property has been changed to a private property that is now accessed through the magic __get() method. The magic getter makes use of a new public method, WP_Block_Type::get_variations which will build variations from a registered callback if variations have not already been built.

Props spacedmonkey, thekt12, Mamaduka, gaambo, gziolo, mukesh27, joemcgill.
Fixes #59969.

File:

• trunk/tests/phpunit/tests/rest-api/rest-block-type-controller.php (modified) (1 diff)

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

@@ -736 +736 @@
 
     /**
+     * @ticket 59969
+     */
+    public function test_variation_callback() {
+        $block_type = 'test/block';
+        $settings   = array(
+            'title'              => true,
+            'variation_callback' => array( $this, 'mock_variation_callback' ),
+        );
+        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( $this->mock_variation_callback(), $data['variations'] );
+    }
+
+    /**
+     * Mock variation callback.
+     *
+     * @return array
+     */
+    public function mock_variation_callback() {
+        return array(
+            array( 'name' => 'var1' ),
+            array( 'name' => 'var2' ),
+        );
+    }
+
+    /**
      * The create_item() method does not exist for block types.
      *