Docs: Document the array shapes for parsed blocks, template part areas, and template types.
See #60699 Built from https://develop.svn.wordpress.org/trunk@58084 git-svn-id: http://core.svn.wordpress.org/trunk@57549 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
@@ -49,7 +49,7 @@ class WP_Block_Parser {
|
||||
public $stack;
|
||||
|
||||
/**
|
||||
* Parses a document and returns a list of block structures
|
||||
* Parses a document and returns a list of block structures.
|
||||
*
|
||||
* When encountering an invalid parse will return a best-effort
|
||||
* parse. In contrast to the specification parser this does not
|
||||
@@ -58,7 +58,21 @@ 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 {
|
||||
* A representative array of a single parsed block object. See WP_Block_Parser_Block.
|
||||
*
|
||||
* @type string $blockName Name of block.
|
||||
* @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;
|
||||
|
||||
Reference in New Issue
Block a user