Solve #18704 on front-end

lib/class-wp-block.php

@@ -0,0 +1,261 @@
+<?php
+/**
+ * Blocks API: WP_Block class
+ *
+ * @package Gutenberg
+ */
+
+/**
+ * Class representing a parsed instance of a block.
+ *
+ * This class can be removed when plugin support requires WordPress 5.5.0+.
+ *
+ * @see https://core.trac.wordpress.org/ticket/49926
+ * @see https://core.trac.wordpress.org/changeset/48159
+ *
+ * @property array $attributes
+ */
+class WP_Block {
+
+	/**
+	 * Array of blocks currently being rendered.
+	 *
+	 * @var array
+	 */
+	private static $currently_rendering = array();
+
+	/**
+	 * Original parsed array representation of block.
+	 *
+	 * @var array
+	 */
+	public $parsed_block;
+
+	/**
+	 * Name of block.
+	 *
+	 * @example "core/paragraph"
+	 *
+	 * @var string
+	 */
+	public $name;
+
+	/**
+	 * Block type associated with the instance.
+	 *
+	 * @var WP_Block_Type
+	 */
+	public $block_type;
+
+	/**
+	 * Block context values.
+	 *
+	 * @var array
+	 */
+	public $context = array();
+
+	/**
+	 * All available context of the current hierarchy.
+	 *
+	 * @var array
+	 * @access protected
+	 */
+	protected $available_context;
+
+	/**
+	 * List of inner blocks (of this same class)
+	 *
+	 * @var WP_Block[]
+	 */
+	public $inner_blocks = array();
+
+	/**
+	 * Resultant HTML from inside block comment delimiters after removing inner
+	 * blocks.
+	 *
+	 * @example "...Just <!-- wp:test /--> testing..." -> "Just testing..."
+	 *
+	 * @var string
+	 */
+	public $inner_html = '';
+
+	/**
+	 * List of string fragments and null markers where inner blocks were found
+	 *
+	 * @example array(
+	 *   'inner_html'    => 'BeforeInnerAfter',
+	 *   'inner_blocks'  => array( block, block ),
+	 *   'inner_content' => array( 'Before', null, 'Inner', null, 'After' ),
+	 * )
+	 *
+	 * @var array
+	 */
+	public $inner_content = array();
+
+	/**
+	 * Constructor.
+	 *
+	 * Populates object properties from the provided block instance argument.
+	 *
+	 * The given array of context values will not necessarily be available on
+	 * the instance itself, but is treated as the full set of values provided by
+	 * the block's ancestry. This is assigned to the private `available_context`
+	 * property. Only values which are configured to consumed by the block via
+	 * its registered type will be assigned to the block's `context` property.
+	 *
+	 * @param array                  $block             Array of parsed block properties.
+	 * @param array                  $available_context Optional array of ancestry context values.
+	 * @param WP_Block_Type_Registry $registry          Optional block type registry.
+	 */
+	public function __construct( $block, $available_context = array(), $registry = null ) {
+		$this->parsed_block = $block;
+		$this->name         = $block['blockName'];
+
+		if ( is_null( $registry ) ) {
+			$registry = WP_Block_Type_Registry::get_instance();
+		}
+
+		$this->block_type = $registry->get_registered( $this->name );
+
+		if ( ! empty( $this->block_type->context ) ) {
+			$message = sprintf(
+				/* translators: 1: Block name. */
+				__( 'The "context" parameter provided in block type "%s" is deprecated. Please use "uses_context" instead.', 'gutenberg' ),
+				$this->name
+			);
+			_doing_it_wrong( __CLASS__, $message, '8.6.0' );
+			$this->block_type->uses_context = $this->block_type->context;
+		}
+		if ( ! empty( $this->block_type->providesContext ) ) {
+			$message = sprintf(
+				/* translators: 1: Block name. */
+				__( 'The "providesContext" parameter provided in block type "%s" is deprecated. Please use "provides_context".', 'gutenberg' ),
+				$this->name
+			);
+			_doing_it_wrong( __CLASS__, $message, '8.6.0' );
+			$this->block_type->provides_context = $this->block_type->providesContext;
+		}
+
+		$this->available_context = $available_context;
+
+		if ( ! empty( $this->block_type->uses_context ) ) {
+			foreach ( $this->block_type->uses_context as $context_name ) {
+				if ( array_key_exists( $context_name, $this->available_context ) ) {
+					$this->context[ $context_name ] = $this->available_context[ $context_name ];
+				}
+			}
+		}
+
+		if ( ! empty( $block['innerBlocks'] ) ) {
+			$child_context = $this->available_context;
+
+			if ( ! empty( $this->block_type->provides_context ) ) {
+				foreach ( $this->block_type->provides_context as $context_name => $attribute_name ) {
+					if ( array_key_exists( $attribute_name, $this->attributes ) ) {
+						$child_context[ $context_name ] = $this->attributes[ $attribute_name ];
+					}
+				}
+			}
+
+			$this->inner_blocks = new WP_Block_List( $block['innerBlocks'], $child_context, $registry );
+		}
+
+		if ( ! empty( $block['innerHTML'] ) ) {
+			$this->inner_html = $block['innerHTML'];
+		}
+
+		if ( ! empty( $block['innerContent'] ) ) {
+			$this->inner_content = $block['innerContent'];
+		}
+	}
+
+	/**
+	 * Returns a value from an inaccessible property.
+	 *
+	 * This is used to lazily initialize the `attributes` property of a block,
+	 * such that it is only prepared with default attributes at the time that
+	 * the property is accessed. For all other inaccessible properties, a `null`
+	 * value is returned.
+	 *
+	 * @param string $name Property name.
+	 *
+	 * @return array|null Prepared attributes, or null.
+	 */
+	public function __get( $name ) {
+		if ( 'attributes' === $name ) {
+			$this->attributes = isset( $this->parsed_block['attrs'] ) ?
+				$this->parsed_block['attrs'] :
+				array();
+
+			if ( ! is_null( $this->block_type ) ) {
+				$this->attributes = $this->block_type->prepare_attributes_for_render( $this->attributes );
+			}
+
+			return $this->attributes;
+		}
+
+		return null;
+	}
+
+	/**
+	 * Generates the render output for the block.
+	 *
+	 * @param array $options {
+	 *   Optional options object.
+	 *
+	 *   @type bool $dynamic Defaults to 'true'. Optionally set to false to avoid using the block's render_callback.
+	 * }
+	 *
+	 * @return string Rendered block output.
+	 */
+	public function render( $options = array() ) {
+		global $post;
+		$options = array_replace(
+			array(
+				'dynamic' => true,
+			),
+			$options
+		);
+
+		$is_dynamic    = $options['dynamic'] && $this->name && null !== $this->block_type && $this->block_type->is_dynamic();
+
+		if ( in_array( (array) $this, self::$currently_rendering ) && $is_dynamic ) {
+			return '';
+		} else {
+			self::$currently_rendering[] = (array) $this;
+		}
+
+		$block_content = '';
+
+		if ( ! $options['dynamic'] || empty( $this->block_type->skip_inner_blocks ) ) {
+			$index = 0;
+			foreach ( $this->inner_content as $chunk ) {
+				$block_content .= is_string( $chunk ) ?
+					$chunk :
+					$this->inner_blocks[ $index++ ]->render();
+			}
+		}
+
+		if ( $is_dynamic ) {
+			$global_post   = $post;
+			$block_content = (string) call_user_func( $this->block_type->render_callback, $this->attributes, $block_content, $this );
+			$post          = $global_post;
+		}
+
+		if ( ! empty( $this->block_type->script ) ) {
+			wp_enqueue_script( $this->block_type->script );
+		}
+
+		if ( ! empty( $this->block_type->style ) ) {
+			wp_enqueue_style( $this->block_type->style );
+		}
+
+		/** This filter is documented in src/wp-includes/blocks.php */
+		$block_content = apply_filters( 'render_block', $block_content, $this->parsed_block );
+
+		array_pop( self::$currently_rendering );
+
+		return $block_content;
+	}
+
+}