WordPress/wp-includes/class-wp-block-parser-block...

91 lines
2.5 KiB
PHP
Raw Permalink Normal View History

<?php
/**
* Block Serialization Parser
*
* @package WordPress
*/
/**
* Class WP_Block_Parser_Block
*
* Holds the block structure in memory
*
* @since 5.0.0
*/
class WP_Block_Parser_Block {
/**
* Name of block
*
* @example "core/paragraph"
*
* @since 5.0.0
* @var string
*/
public $blockName; // phpcs:ignore WordPress.NamingConventions.ValidVariableName
/**
* Optional set of attributes from block comment delimiters
*
* @example null
* @example array( 'columns' => 3 )
*
* @since 5.0.0
* @var array|null
*/
public $attrs;
/**
* List of inner blocks (of this same class)
*
* @since 5.0.0
* @var WP_Block_Parser_Block[]
*/
public $innerBlocks; // phpcs:ignore WordPress.NamingConventions.ValidVariableName
/**
* Resultant HTML from inside block comment delimiters
* after removing inner blocks
*
* @example "...Just <!-- wp:test /--> testing..." -> "Just testing..."
*
* @since 5.0.0
* @var string
*/
public $innerHTML; // phpcs:ignore WordPress.NamingConventions.ValidVariableName
/**
* List of string fragments and null markers where inner blocks were found
*
* @example array(
* 'innerHTML' => 'BeforeInnerAfter',
* 'innerBlocks' => array( block, block ),
* 'innerContent' => array( 'Before', null, 'Inner', null, 'After' ),
* )
*
* @since 4.2.0
* @var array
*/
public $innerContent; // phpcs:ignore WordPress.NamingConventions.ValidVariableName
/**
* Constructor.
*
* Will populate object properties from the provided arguments.
*
* @since 5.0.0
*
* @param string $name Name of block.
* @param array $attrs Optional set of attributes from block comment delimiters.
* @param array $inner_blocks List of inner blocks (of this same class).
* @param string $inner_html Resultant HTML from inside block comment delimiters after removing inner blocks.
* @param array $inner_content List of string fragments and null markers where inner blocks were found.
*/
public function __construct( $name, $attrs, $inner_blocks, $inner_html, $inner_content ) {
$this->blockName = $name; // phpcs:ignore WordPress.NamingConventions.ValidVariableName
$this->attrs = $attrs;
$this->innerBlocks = $inner_blocks; // phpcs:ignore WordPress.NamingConventions.ValidVariableName
$this->innerHTML = $inner_html; // phpcs:ignore WordPress.NamingConventions.ValidVariableName
$this->innerContent = $inner_content; // phpcs:ignore WordPress.NamingConventions.ValidVariableName
}
}