WordPress.org

parse_blocks( string $content )

Parses blocks out of a content string.

Contents

Parameters
Return
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes

Parameters Parameters

$content: (string) (Required) Post content.

Return Return

(array[]) Array of parsed block objects.

Source Source

File: wp-includes/blocks.php

function parse_blocks( $content ) {
	/**
	 * Filter to allow plugins to replace the server-side block parser
	 *
	 * @since 5.0.0
	 *
	 * @param string $parser_class Name of block parser class.
	 */
	$parser_class = apply_filters( 'block_parser_class', 'WP_Block_Parser' );

	$parser = new $parser_class();
	return $parser->parse( $content );
}

Expand full source code Collapse full source code View on Trac

Uses Uses

Uses
Uses	Description
wp-includes/blocks.php: block_parser_class	Filter to allow plugins to replace the server-side block parser
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.

Used By Used By

Used By
Used By	Description
wp-includes/widgets/class-wp-widget-block.php: WP_Widget_Block::get_dynamic_classname()	Calculates the classname to use in the block widget’s container HTML.
wp-includes/blocks.php: filter_block_content()	Filters and sanitizes block content to remove non-allowable HTML from parsed block attribute values.
wp-includes/blocks.php: do_blocks()	Parses dynamic blocks out of `post_content` and re-renders them.
wp-includes/blocks.php: excerpt_remove_blocks()	Parses blocks out of a content string, and renders those appropriate for the excerpt.

Changelog Changelog

Changelog
Version	Description
5.0.0	Introduced.

User Contributed Notes User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

Contributed by Joseph Dickson — 1 year ago
Example using parse_blocks() to display a block from a post
<?php function wpdocs_display_post_youtube_block() { global $post; $blocks = parse_blocks( $post->post_content ); foreach ( $blocks as $block ) { // YouTube's block name if ( 'core-embed/youtube' === $block['blockName'] ) { echo apply_filters( 'the_content', render_block( $block ) ); break; } } } ?>
Expand full source code Collapse full source code
Place within The Loop
```
<?php
// Add within the loop

// Check if the YouTube block is used in the post using the blockName
if ( has_block( 'core-embed/youtube' ) ) {
 
	// Display the YouTube block from the post
	wpdocs_display_post_youtube_block();
 
}

?>
```
If used in The Loop it renders the first YouTube video embedded within a post. Can be used with other blocks by assigning their blockName.
Feedback
- This embed example is now defunct as of WordPress 5.6 changing to the block name to core/embed and adding variations. I’ll submit a new sample. — By Joseph Dickson — 9 months ago
Log in to add feedback

2

Contributed by Jb Audras — 2 years ago

Example of returned array for a Paragraph block:

array ( 
	0 => array ( 
		'blockName' => 'core/paragraph', 
		'attrs' => array ( 
			'textColor' => 'vivid-red', 
			'backgroundColor' => 'luminous-vivid-amber',
		), 
		'innerBlocks' => array (
			/* Child blocks if they exists (used in Column Block for example) */
		), 
		'innerHTML' => 'This is a block content!', 
		'innerContent' => array (
			0 => 'This is a block content!',
		), 
	),
)

Expand full source code Collapse full source code

Skip to note 3 content

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

Contributed by Khoi Pro — 3 months ago
In case you wish to check if current post content is Gutenberg-blocks or using Classic editor:
```
    global $post;
    $blocks = parse_blocks( $post->post_content );
    $is_gutenberg_page = ( ! empty( $blocks ) && '' !== $blocks[0]['blockName'] );
```
If post content is Classic Editor, it has only one block, but blockName is empty.
Log in to add feedback

0

Contributed by André — 2 years ago

As of Gutenberg 7.7, for this input:

<!-- wp:paragraph {
    "placeholder":"Summary",
    "textColor":"accent",
    "backgroundColor":"secondary"
} -->
<p class="has-text-color has-background has-accent-color has-secondary-background-color">
This is a new paragraph.
</p>
<!-- /wp:paragraph -->

the output of parse_blocks will be:

Array
(
  [0] => Array
    (
      [blockName] => core/paragraph
      [attrs] => Array
        (
          [placeholder] => Summary
          [textColor] => accent
          [backgroundColor] => secondary
        )
      [innerBlocks] => Array()
      [innerHTML] => <p class="has-text-color has-background has-accent-color has-secondary-background-color">This is a new paragraph.</p>
      [innerContent] => Array
        (
          [0] => <p class="has-text-color has-background has-accent-color has-secondary-background-color">This is a new paragraph.</p>
        )
      )
)

Expand full source code Collapse full source code

You must log in before being able to contribute a note or feedback.