parse_blocks( string $content ): array[]

User Contributed Notes

1. Skip to note 6 content

   Joseph Dickson 5 years ago

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

   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.

   • 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.

     Joseph Dickson 4 years ago
2. Skip to note 7 content

   Ulrich 4 years ago

   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

   Use serialize_blocks() to convert the parsed block back to content.
3. Skip to note 8 content

   Jb Audras 6 years ago

   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

   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 9 content

   André Maneiro 5 years ago

   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

   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 10 content

   Khoi Pro 4 years ago

   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

   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.

   • There is a better way for this. Function has_blocks() .

     Lovro Hrust 3 years ago
   • Currently, a much less costly method would use the has_blocks() function, which accepts either the unparsed post content or a wp_post object. $fullContent = get_the_content( $pid ); if ( has_blocks( $fullContent ) ) { doit(); } or if ( has_blocks( $post ) ) { doit(); }

     Brian Layman 2 years ago