WP_Block_Processor::extract_full_block_and_advance(): array[]|null
- Since
- 6.9.0
- Source
wp-includes/class-wp-block-processor.php:1257
Description
Use this function to extract some blocks within a document, but not all. For example, one might want to find image galleries, parse them, modify them, and then reserialize them in place.
Once this function returns, the parser will be matched on token following the close of the given block.
The return type of this method is compatible with the return of parse_blocks().
Example:
$processor = new WP_Block_Processor( $post_content );
if ( ! $processor->next_block( 'gallery' ) ) {
return $post_content;
}
$gallery_at = $processor->get_span()->start;
$gallery = $processor->extract_full_block_and_advance();
$ends_before = $processor->get_span();
$ends_before = $ends_before->start ?? strlen( $post_content );
$new_gallery = update_gallery( $gallery );
$new_gallery = serialize_block( $new_gallery );
return (
substr( $post_content, 0, $gallery_at ) .
$new_gallery .
substr( $post_content, $ends_before )
);Compatibility
- WordPress
- since 6.9.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 3 of the 5 tracked releases, added in 6.9.0, and compiles on PHP 7.4 through 8.6-dev.
Return value
array[]|null- Array of block structures.
...$0arrayAn associative array of a single parsed block object. See WP_Block_Parser_Block.$blockNamestring|nullName of block.$attrsarrayAttributes from block comment delimiters.$innerBlocksarray[]List of inner blocks. An array of arrays that have the same structure as this one.$innerHTMLstringHTML from inside block comment delimiters.$innerContentarrayList of string fragments and null markers where inner blocks were found.
Performance profile
How much work a call to WP_Block_Processor::extract_full_block_and_advance() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Light
- Scaling
- Scales with input
- Instructions
- 13–27
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 72.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Block_Processor::extract_full_block_and_advance() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
->is_html() | 13 | ->is_html(), ->get_html_content() |
!->is_html() && !->next_token() | 22–23 | ->is_html(), ->get_block_type(), ->allocate_and_return_parsed_attributes(), ->get_depth(), ->next_token() |
!->is_html() && ->next_token() && !$depth | 26–27 | ->is_html(), ->get_block_type(), ->allocate_and_return_parsed_attributes(), ->get_depth(), ->next_token(), ->get_depth() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 72 instructions, 13–27 executed per call, 7 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 8
- WP_Block_Processor::is_html()Indicates if the matched delimiter is an HTML span.
- WP_Block_Processor::get_html_content()Returns the string content of a matched HTML span, or `null` otherwise.
- WP_Block_Processor::get_block_type()Allocates a substring for the block type and returns the fully-qualified name, including the namespace, if matched on a delimiter, otherwise `null`.
- WP_Block_Processor::allocate_and_return_parsed_attributes()Attempts to parse and return the entire JSON attributes from the delimiter, allocating memory and processing the JSON span in the process.
- WP_Block_Processor::get_depth()Returns the depth of the open blocks where the processor is currently matched.
- WP_Block_Processor::next_token()Advance to the next block delimiter or HTML span in a document, indicating if one was found.
- WP_Block_Processor::opens_block()Indicates if the matched delimiter is an opening or void delimiter of the given type, if a type is provided, otherwise if it opens any block or implicit freeform HTML content.
- WP_Block_Processor::extract_full_block_and_advance()Extracts a block object, and all inner content, starting at a matched opening block delimiter, or at a matched top-level HTML span as freeform HTML content.
Used by · 1
- WP_Block_Processor::extract_full_block_and_advance()Extracts a block object, and all inner content, starting at a matched opening block delimiter, or at a matched top-level HTML span as freeform HTML content.
Source code
public function extract_full_block_and_advance(): ?array { if ( $this->is_html() ) { $chunk = $this->get_html_content(); return array( 'blockName' => null, 'attrs' => array(), 'innerBlocks' => array(), 'innerHTML' => $chunk, 'innerContent' => array( $chunk ), ); } $block = array( 'blockName' => $this->get_block_type(), 'attrs' => $this->allocate_and_return_parsed_attributes() ?? array(), 'innerBlocks' => array(), 'innerHTML' => '', 'innerContent' => array(), ); $depth = $this->get_depth(); while ( $this->next_token() && $this->get_depth() > $depth ) { if ( $this->is_html() ) { $chunk = $this->get_html_content(); $block['innerHTML'] .= $chunk; $block['innerContent'][] = $chunk; continue; } /** * Inner blocks. * * @todo This is a decent place to call {@link \render_block()} * @todo Use iteration instead of recursion, or at least refactor to tail-call form. */ if ( $this->opens_block() ) { $inner_block = $this->extract_full_block_and_advance(); $block['innerBlocks'][] = $inner_block; $block['innerContent'][] = null; } /* * Because the parser has advanced past the closing block token, it * may be matched on an HTML span. This needs to be processed before * moving on to the next token at the start of the next loop iteration. */ if ( $this->is_html() ) { $chunk = $this->get_html_content(); $block['innerHTML'] .= $chunk; $block['innerContent'][] = $chunk; } } return $block; }Changelog
Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.
Signature, return type and hooks compared across 3 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-block-processor.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.