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

Timestamp:

02/02/2024 08:22:11 PM (15 months ago)

Author:

gziolo

Message:

Editor: Refactor the way block bindings sources are handled

It fixes the coding style issues reported. It goes further and improves the code quality it other places where the logic for block bindings was added.

Follow-up for [57514].
Props: gziolo, mukesh27, youknowriad, santosguillamot.
See #60282.

File:

• trunk/src/wp-includes/class-wp-block.php (modified) (7 diffs)

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

@@ -212 +212 @@
      *     "bindings": {
      *       "title": {
-     *         "source": "post_meta",
+     *         "source": "core/post-meta",
      *         "args": { "key": "text_custom_field" }
      *       },
      *       "url": {
-     *         "source": "post_meta",
+     *         "source": "core/post-meta",
      *         "args": { "key": "url_custom_field" }
      *       }
@@ -227 +227 @@
      * block with the values of the `text_custom_field` and `url_custom_field` post meta.
      *
-     * @access private
      * @since 6.5.0
      *
-     * @param string   $block_content Block content.
-     * @param array    $block The full block, including name and attributes.
+     * @param string $block_content Block content.
+     * @param array  $block         The full block, including name and attributes.
+     * @return string The modified block content.
      */
     private function process_block_bindings( $block_content ) {
-        $block = $this->parsed_block;
+        $parsed_block = $this->parsed_block;
 
         // Allowed blocks that support block bindings.
@@ -247 +247 @@
         // If the block doesn't have the bindings property, isn't one of the allowed
         // block types, or the bindings property is not an array, return the block content.
-        if ( ! isset( $block['attrs']['metadata']['bindings'] ) ||
-                ! is_array( $block['attrs']['metadata']['bindings'] ) ||
-                ! isset( $allowed_blocks[ $this->name ] )
-                ) {
+        if (
+            ! isset( $allowed_blocks[ $this->name ] ) ||
+            empty( $parsed_block['attrs']['metadata']['bindings'] ) ||
+            ! is_array( $parsed_block['attrs']['metadata']['bindings'] )
+        ) {
             return $block_content;
         }
 
-        $block_bindings_sources = get_all_registered_block_bindings_sources();
         $modified_block_content = $block_content;
-        foreach ( $block['attrs']['metadata']['bindings'] as $binding_attribute => $binding_source ) {
-            // If the attribute is not in the list, process next attribute.
-            if ( ! in_array( $binding_attribute, $allowed_blocks[ $this->name ], true ) ) {
+        foreach ( $parsed_block['attrs']['metadata']['bindings'] as $attribute_name => $block_binding ) {
+            // If the attribute is not in the allowed list, process next attribute.
+            if ( ! in_array( $attribute_name, $allowed_blocks[ $this->name ], true ) ) {
                 continue;
             }
             // If no source is provided, or that source is not registered, process next attribute.
-            if ( ! isset( $binding_source['source'] ) || ! is_string( $binding_source['source'] ) || ! isset( $block_bindings_sources[ $binding_source['source'] ] ) ) {
+            if ( ! isset( $block_binding['source'] ) || ! is_string( $block_binding['source'] ) ) {
                 continue;
             }
 
-            $source_callback = $block_bindings_sources[ $binding_source['source'] ]['get_value_callback'];
-            // Get the value based on the source.
-            if ( ! isset( $binding_source['args'] ) ) {
-                $source_args = array();
-            } else {
-                $source_args = $binding_source['args'];
-            }
-            $source_value = call_user_func_array( $source_callback, array( $source_args, $this, $binding_attribute ) );
-            // If the value is null, process next attribute.
-            if ( is_null( $source_value ) ) {
+            $block_binding_source = get_block_bindings_source( $block_binding['source'] );
+            if ( null === $block_binding_source ) {
                 continue;
             }
 
-            // Process the HTML based on the block and the attribute.
-            $modified_block_content = $this->replace_html( $modified_block_content, $this->name, $binding_attribute, $source_value );
-        }
+            $source_callback = $block_binding_source['get_value_callback'];
+            $source_args     = ! empty( $block_binding['args'] ) && is_array( $block_binding['args'] ) ? $block_binding['args'] : array();
+            $source_value    = call_user_func_array( $source_callback, array( $source_args, $this, $attribute_name ) );
+
+            // If the value is not null, process the HTML based on the block and the attribute.
+            if ( ! is_null( $source_value ) ) {
+                $modified_block_content = $this->replace_html( $modified_block_content, $attribute_name, $source_value );
+            }
+        }
+
         return $modified_block_content;
     }
 
     /**
-     * Depending on the block attributes, replace the HTML based on the value returned by the source.
+     * Depending on the block attribute name, replace its value in the HTML based on the value provided.
      *
      * @since 6.5.0
      *
-     * @param string $block_content Block content.
-     * @param string $block_name The name of the block to process.
-     * @param string $block_attr The attribute of the block we want to process.
-     * @param string $source_value The value used to replace the HTML.
-     */
-    private function replace_html( string $block_content, string $block_name, string $block_attr, string $source_value ) {
+     * @param string $block_content  Block content.
+     * @param string $attribute_name The attribute name to replace.
+     * @param mixed  $source_value   The value used to replace in the HTML.
+     * @return string The modified block content.
+     */
+    private function replace_html( string $block_content, string $attribute_name, $source_value ) {
         $block_type = $this->block_type;
-        if ( null === $block_type || ! isset( $block_type->attributes[ $block_attr ] ) ) {
+        if ( ! isset( $block_type->attributes[ $attribute_name ] ) ) {
             return $block_content;
         }
 
         // Depending on the attribute source, the processing will be different.
-        switch ( $block_type->attributes[ $block_attr ]['source'] ) {
+        switch ( $block_type->attributes[ $attribute_name ]['source'] ) {
             case 'html':
             case 'rich-text':
@@ -309 +308 @@
                 // TODO: Support for CSS selectors whenever they are ready in the HTML API.
                 // In the meantime, support comma-separated selectors by exploding them into an array.
-                $selectors = explode( ',', $block_type->attributes[ $block_attr ]['selector'] );
+                $selectors = explode( ',', $block_type->attributes[ $attribute_name ]['selector'] );
                 // Add a bookmark to the first tag to be able to iterate over the selectors.
                 $block_reader->next_tag();
@@ -317 +316 @@
                 // Store the parent tag and its attributes to be able to restore them later in the button.
                 // The button block has a wrapper while the paragraph and heading blocks don't.
-                if ( 'core/button' === $block_name ) {
+                if ( 'core/button' === $this->name ) {
                     $button_wrapper                 = $block_reader->get_tag();
                     $button_wrapper_attribute_names = $block_reader->get_attribute_names_with_prefix( '' );
@@ -349 +348 @@
                             $amended_content->set_attribute( $attribute_key, $attribute_value );
                         }
-                        if ( 'core/paragraph' === $block_name || 'core/heading' === $block_name ) {
+                        if ( 'core/paragraph' === $this->name || 'core/heading' === $this->name ) {
                             return $amended_content->get_updated_html();
                         }
-                        if ( 'core/button' === $block_name ) {
+                        if ( 'core/button' === $this->name ) {
                             $button_markup  = "<$button_wrapper>{$amended_content->get_updated_html()}</$button_wrapper>";
                             $amended_button = new WP_HTML_Tag_Processor( $button_markup );
@@ -373 +372 @@
                     array(
                         // TODO: build the query from CSS selector.
-                        'tag_name' => $block_type->attributes[ $block_attr ]['selector'],
+                        'tag_name' => $block_type->attributes[ $attribute_name ]['selector'],
                     )
                 ) ) {
                     return $block_content;
                 }
-                $amended_content->set_attribute( $block_type->attributes[ $block_attr ]['attribute'], esc_attr( $source_value ) );
+                $amended_content->set_attribute( $block_type->attributes[ $attribute_name ]['attribute'], esc_attr( $source_value ) );
                 return $amended_content->get_updated_html();
                 break;