Changeset 54132

Timestamp:

09/12/2022 01:12:21 PM (2 years ago)

Author:

gziolo

Message:

Blocks: Add new render property in block.json for block types

New render field in block.json file that accepts a string value. It allows to pass a path to the PHP file that is going to be used to render the block on the server. Related PR in Gutenberg: ​https://github.com/WordPress/gutenberg/pull/42430.

Props spacedmonkey, luisherranz, welcher, noisysocks, matveb, fabiankaegy, aristath, zieladam.
Fixes #53148.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (2 diffs)
• tests/phpunit/data/blocks/notice/block.json (modified) (2 diffs)
• tests/phpunit/data/blocks/notice/render.php (added)
• tests/phpunit/tests/blocks/register.php (modified) (2 diffs)
• tests/phpunit/tests/blocks/render.php (modified) (2 diffs)

trunk/src/wp-includes/blocks.php

@@ -236 +236 @@
  * @since 5.7.0 Added support for `textdomain` field and i18n handling for all translatable fields.
  * @since 5.9.0 Added support for `variations` and `viewScript` fields.
+ * @since 6.1.0 Added support for `render` field.
  *
  * @param string $file_or_folder Path to the JSON file with metadata definition for
@@ -344 +345 @@
             'style'
         );
+    }
+
+    if ( ! empty( $metadata['render'] ) ) {
+        $template_path = wp_normalize_path(
+            realpath(
+                dirname( $metadata['file'] ) . '/' .
+                remove_block_asset_path_prefix( $metadata['render'] )
+            )
+        );
+        if ( file_exists( $template_path ) ) {
+            /**
+             * Renders the block on the server.
+             *
+             * @since 6.1.0
+             *
+             * @param array    $attributes Block attributes.
+             * @param string   $content    Block default content.
+             * @param WP_Block $block      Block instance.
+             *
+             * @return string Returns the block content.
+             */
+            $settings['render_callback'] = function( $attributes, $content, $block ) use ( $template_path ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+                ob_start();
+                require $template_path;
+                return ob_get_clean();
+            };
+        }
     }
 

trunk/tests/phpunit/data/blocks/notice/block.json

@@ -25 +25 @@
     "attributes": {
         "message": {
-            "type": "string",
-            "source": "html",
-            "selector": ".message"
+            "type": "string"
         }
     },
@@ -62 +60 @@
     "viewScript": "tests-notice-view-script",
     "editorStyle": "tests-notice-editor-style",
-    "style": "tests-notice-style"
+    "style": "tests-notice-style",
+    "render": "file:./render.php"
 }

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

@@ -390 +390 @@
             array(
                 'message' => array(
-                    'type'     => 'string',
-                    'source'   => 'html',
-                    'selector' => '.message',
+                    'type' => 'string',
                 ),
                 'lock'    => array( 'type' => 'object' ),
@@ -456 +454 @@
             wp_normalize_path( wp_styles()->get_data( 'unit-tests-test-block-style', 'path' ) )
         );
+
+        // @ticket 53148
+        $this->assertIsCallable( $result->render_callback );
     }
 

trunk/tests/phpunit/tests/blocks/render.php

@@ -48 +48 @@
             $registry->unregister( 'core/dynamic' );
         }
+        if ( $registry->is_registered( 'tests/notice' ) ) {
+            $registry->unregister( 'tests/notice' );
+        }
 
         parent::tear_down();
@@ -237 +240 @@
         );
     }
+
+    /**
+     * @ticket 53148
+     */
+    public function test_render_field_in_block_json() {
+        $result = register_block_type(
+            DIR_TESTDATA . '/blocks/notice'
+        );
+
+        $actual_content = do_blocks( '<!-- wp:tests/notice {"message":"Hello from the test"} --><!-- /wp:tests/notice -->' );
+        $this->assertSame( '<p class="wp-block-tests-notice">Hello from the test</p>', trim( $actual_content ) );
+    }
+
 
     /**