parse_blocks( string $content ): array[]

Parses blocks out of a content string.

Contents

Parameters

$content string Required
Post content.

Top ↑

Return

array[] Array of parsed block objects.

Top ↑

Source

File: wp-includes/blocks.php. View all references 

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 );
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Top ↑

Used By

Used By
Used By Description
wp_get_post_content_block_attributes() wp-includes/block-editor.php

Retrieves Post Content block attributes from the current post template.
_inject_theme_attribute_in_block_template_content() wp-includes/block-template-utils.php

Parses wp_template content and injects the active theme’s stylesheet as a theme attribute into each wp_template_part
_remove_theme_attribute_in_block_template_content() wp-includes/block-template-utils.php

Parses a block template and removes the theme attribute from each template part.
WP_Widget_Block::get_dynamic_classname() wp-includes/widgets/class-wp-widget-block.php

Calculates the classname to use in the block widget’s container HTML.
filter_block_content() wp-includes/blocks.php

Filters and sanitizes block content to remove non-allowable HTML from parsed block attribute values.
do_blocks() wp-includes/blocks.php

Parses dynamic blocks out of post_content and re-renders them.
excerpt_remove_blocks() wp-includes/blocks.php

Parses blocks out of a content string, and renders those appropriate for the excerpt.
get_post_galleries() wp-includes/media.php

Retrieves galleries from the passed post’s content.
Show 3 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
5.0.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
    Contributed by Joseph Dickson —

    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;
			
		}
		
	}
	
}

?>

    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.

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Jb Audras —

    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!',
		), 
	),
)
  4. Skip to note 4 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 André —

    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>
        )
      )
)
  5. Skip to note 5 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Khoi Pro —

    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.

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