Changeset 58801 for trunk/src/wp-includes/blocks.php

Timestamp:

07/24/2024 02:09:58 PM (6 months 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/src/wp-includes/blocks.php (modified) (2 diffs)

trunk/src/wp-includes/blocks.php

@@ -386 +386 @@
  * @since 6.4.0 Added support for `blockHooks` field.
  * @since 6.5.0 Added support for `allowedBlocks`, `viewScriptModule`, and `viewStyle` fields.
+ * @since 6.7.0 Allow PHP filename as `variations` argument.
  *
  * @param string $file_or_folder Path to the JSON file with metadata definition for
@@ -523 +524 @@
     }
 
+    // If `variations` is a string, it's the name of a PHP file that
+    // generates the variations.
+    if ( ! empty( $metadata['variations'] ) && is_string( $metadata['variations'] ) ) {
+        $variations_path = wp_normalize_path(
+            realpath(
+                dirname( $metadata['file'] ) . '/' .
+                remove_block_asset_path_prefix( $metadata['variations'] )
+            )
+        );
+        if ( $variations_path ) {
+            /**
+             * Generates the list of block variations.
+             *
+             * @since 6.7.0
+             *
+             * @return string Returns the list of block variations.
+             */
+            $settings['variation_callback'] = static function () use ( $variations_path ) {
+                $variations = require $variations_path;
+                return $variations;
+            };
+            // The block instance's `variations` field is only allowed to be an array
+            // (of known block variations). We unset it so that the block instance will
+            // provide a getter that returns the result of the `variation_callback` instead.
+            unset( $settings['variations'] );
+        }
+    }
+
     $settings = array_merge( $settings, $args );