Skip to content

Correctly document the blockName property as being nullable #70900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
youknowriad merged 4 commits into from
Sep 30, 2026
Merged

Correctly document the blockName property as being nullable #70900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0f24e37
Correctly document the `blockName` property as being nullable.
johnbillion Jul 24, 2025
ca92132
Update these too.
johnbillion Jul 24, 2025
c9f3f7e
Merge trunk into pr-70900
youknowriad Sep 30, 2026
d527a3e
Document that a null block name means freeform HTML content
youknowriad Sep 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions packages/block-serialization-default-parser/class-wp-block-parser-block.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
*/
class WP_Block_Parser_Block {
/**
* Name of block
* Name of block, or `null` when the block is top-level freeform HTML content.
*
* @example "core/paragraph"
*
* @since 5.0.0
* @var string
* @var string|null
*/
public $blockName; // phpcs:ignore WordPress.NamingConventions.ValidVariableName

Expand Down Expand Up @@ -74,11 +74,11 @@ class WP_Block_Parser_Block {
*
* @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.
* @param string|null $name Name of block, or `null` for freeform HTML content.
* @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
Expand Down
19 changes: 18 additions & 1 deletion packages/block-serialization-default-parser/class-wp-block-parser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ class WP_Block_Parser {
/**
* List of parsed blocks
*
* See WP_Block_Parser_Block for the structure of each block.
*
* @since 5.0.0
* @var array[]
*/
Expand All @@ -59,7 +61,22 @@ class WP_Block_Parser {
* @since 5.0.0
*
* @param string $document Input document being parsed.
* @return array[]
* @return array[] {
* Array of block structures.
*
* @type array ...$0 {
* An associative array of a single parsed block object. See WP_Block_Parser_Block.
*
* @type string|null $blockName Name of block, or `null` when the block is
* top-level freeform HTML content.
* @type array $attrs Attributes from block comment delimiters.
* @type array[] $innerBlocks List of inner blocks. An array of arrays that
* have the same structure as this one.
* @type string $innerHTML HTML from inside block comment delimiters.
* @type array $innerContent List of string fragments and null markers where
* inner blocks were found.
* }
* }
*/
public function parse( $document ) {
$this->document = $document;
Expand Down
Loading