Changeset 57315 for trunk/src/wp-includes/class-wp-block-type.php

Timestamp:

01/19/2024 08:52:06 PM (3 years 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/src/wp-includes/class-wp-block-type.php (modified) (6 diffs)

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

@@ -114 +114 @@
          *
          * @since 5.8.0
-         * @var array[]
-         */
-        public $variations = array();
+         * @since 6.5.0 Only accessible through magic getter. null by default.
+         * @var array[]|null
+         */
+        private $variations = null;
+
+        /**
+         * Block variations callback.
+         *
+         * @since 6.5.0
+         * @var callable|null
+         */
+        public $variation_callback = null;
 
         /**
@@ -297 +306 @@
          *     @type array|null    $example                  Structured data for the block preview.
          *     @type callable|null $render_callback          Block type render callback.
+         *     @type callable|null $variation_callback       Block type variations callback.
          *     @type array|null    $attributes               Block type attributes property schemas.
          *     @type string[]      $uses_context             Context values inherited by blocks of this type.
@@ -326 +336 @@
          */
         public function __get( $name ) {
+                if ( 'variations' === $name ) {
+                        return $this->get_variations();
+                }
+
                 if ( ! in_array( $name, $this->deprecated_properties, true ) ) {
                         return;
@@ -354 +368 @@
          */
         public function __isset( $name ) {
+                if ( 'variations' === $name ) {
+                        return true;
+                }
+
                 if ( ! in_array( $name, $this->deprecated_properties, true ) ) {
                         return false;
@@ -373 +391 @@
          */
         public function __set( $name, $value ) {
+                if ( 'variations' === $name ) {
+                        $this->variations = $value;
+                        return;
+                }
+
                 if ( ! in_array( $name, $this->deprecated_properties, true ) ) {
                         $this->{$name} = $value;
@@ -541 +564 @@
                         array();
         }
+
+        /**
+         * Get block variations.
+         *
+         * @since 6.5.0
+         *
+         * @return array[]
+         */
+        public function get_variations() {
+                if ( ! isset( $this->variations ) ) {
+                        $this->variations = array();
+                        if ( is_callable( $this->variation_callback ) ) {
+                                $this->variations = call_user_func( $this->variation_callback );
+                        }
+                }
+
+                /**
+                 * Filters the registered variations for a block type.
+                 *
+                 * @since 6.5.0
+                 *
+                 * @param array         $variations Array of registered variations for a block type.
+                 * @param WP_Block_Type $block_type The full block type object.
+                 */
+                return apply_filters( 'get_block_type_variations', $this->variations, $this );
+        }
 }