Changeset 48224

Timestamp:

06/30/2020 11:02:22 AM (4 years ago)

Author:

gziolo

Message:

Editor: Introduce block context

Backports a new block context feature from Gutenberg. The purpose of this feature is to be able to establish values in a block hierarchy which can be consumed by blocks anywhere lower in the same hierarchy. These values can be established either by the framework, or by other blocks which provide these values. See documentation: ​https://github.com/WordPress/gutenberg/blob/master/docs/designers-developers/developers/block-api/block-context.md

Props aduth, epiqueras.
Fixes #49927.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (3 diffs)
• src/wp-includes/class-wp-block.php (modified) (1 diff)
• tests/phpunit/tests/blocks/block-context.php (added)

trunk/src/wp-includes/blocks.php

@@ -650 +650 @@
  * @since 5.0.0
  *
- * @global WP_Post $post The post to edit.
- *
- * @param array $block A single parsed block object.
+ * @global WP_Post  $post         The post to edit.
+ * @global WP_Query $wp_the_query WordPress Query object.
+ *
+ * @param array $parsed_block A single parsed block object.
  * @return string String of rendered HTML.
  */
-function render_block( $block ) {
-    global $post;
+function render_block( $parsed_block ) {
+    global $post, $wp_query;
 
     /**
@@ -663 +664 @@
      * @since 5.1.0
      *
-     * @param string|null $pre_render The pre-rendered content. Default null.
-     * @param array       $block      The block being rendered.
+     * @param string|null $pre_render   The pre-rendered content. Default null.
+     * @param array       $parsed_block The block being rendered.
      */
-    $pre_render = apply_filters( 'pre_render_block', null, $block );
+    $pre_render = apply_filters( 'pre_render_block', null, $parsed_block );
     if ( ! is_null( $pre_render ) ) {
         return $pre_render;
     }
 
-    $source_block = $block;
+    $source_block = $parsed_block;
 
     /**
@@ -678 +679 @@
      * @since 5.1.0
      *
-     * @param array $block        The block being rendered.
-     * @param array $source_block An un-modified copy of $block, as it appeared in the source content.
+     * @param array $parsed_block The block being rendered.
+     * @param array $source_block An un-modified copy of $parsed_block, as it appeared in the source content.
      */
-    $block = apply_filters( 'render_block_data', $block, $source_block );
-
-    $block_type    = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
-    $is_dynamic    = $block['blockName'] && null !== $block_type && $block_type->is_dynamic();
-    $block_content = '';
-    $index         = 0;
-
-    foreach ( $block['innerContent'] as $chunk ) {
-        $block_content .= is_string( $chunk ) ? $chunk : render_block( $block['innerBlocks'][ $index++ ] );
-    }
-
-    if ( ! is_array( $block['attrs'] ) ) {
-        $block['attrs'] = array();
-    }
-
-    if ( $is_dynamic ) {
-        $global_post   = $post;
-        $block_content = $block_type->render( $block['attrs'], $block_content );
-        $post          = $global_post;
+    $parsed_block = apply_filters( 'render_block_data', $parsed_block, $source_block );
+
+    $context = array();
+
+    if ( ! empty( $post ) ) {
+        $context['postId'] = $post->ID;
+
+        /*
+        * The `postType` context is largely unnecessary server-side, since the
+        * ID is usually sufficient on its own. That being said, since a block's
+        * manifest is expected to be shared between the server and the client,
+        * it should be included to consistently fulfill the expectation.
+        */
+        $context['postType'] = $post->post_type;
+    }
+
+    if ( isset( $wp_query->tax_query->queried_terms['category'] ) ) {
+        $context['query'] = array( 'categoryIds' => array() );
+        foreach ( $wp_query->tax_query->queried_terms['category']['terms'] as $category_slug_or_id ) {
+            $context['query']['categoryIds'][] = 'slug' === $wp_query->tax_query->queried_terms['category']['field'] ? get_cat_ID( $category_slug_or_id ) : $category_slug_or_id;
+        }
     }
 
     /**
-     * Filters the content of a single block.
-     *
-     * @since 5.0.0
-     *
-     * @param string $block_content The block content about to be appended.
-     * @param array  $block         The full block, including name and attributes.
+     * Filters the default context provided to a rendered block.
+     *
+     * @since 5.5.0
+     *
+     * @param array $context      Default context.
+     * @param array $parsed_block Block being rendered, filtered by `render_block_data`.
      */
-    return apply_filters( 'render_block', $block_content, $block );
+    $context = apply_filters( 'render_block_context', $context, $parsed_block );
+
+    $block = new WP_Block( $parsed_block, $context );
+
+    return $block->render();
 }
 

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

@@ -227 +227 @@
         }
 
-        /** This filter is documented in src/wp-includes/blocks.php */
+        /**
+         * Filters the content of a single block.
+         *
+         * @since 5.0.0
+         *
+         * @param string $block_content The block content about to be appended.
+         * @param array  $block         The full block, including name and attributes.
+         */
         return apply_filters( 'render_block', $block_content, $this->parsed_block );
     }