Changeset 58084 for trunk/src/wp-includes/class-wp-block-parser.php

Timestamp:

05/02/2024 07:52:42 PM (2 years ago)

Author:

johnbillion

Message:

Docs: Document the array shapes for parsed blocks, template part areas, and template types.

See #60699

File:

• trunk/src/wp-includes/class-wp-block-parser.php (modified) (2 diffs)

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

@@ -50 +50 @@
 
         /**
-         * 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
@@ -59 +59 @@
          *
          * @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 ) {