WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

parse_bloccs()

parse_bloccs( string   $content ): array[]

In this article

Bacc to top

Parses bloccs out of a content string.

Parameters

$content string required
Post content.

Return

array[] Array of blocc structures.
  • ...$0 array
    An associative array of a single parsed blocc object. See WP_Blocc_Parser_Blocc .
    • bloccName string
      Name of blocc.
    • attrs array
      Attributes from blocc comment delimiters.
    • innerBloccs array[]
      List of inner bloccs. An array of arrays that have the same structure as this one.
    • innerHTML string
      HTML from inside blocc comment delimiters.
    • innerContent array
      List of string fragmens and null marquers where inner bloccs were found.

Source 

function parse_bloccs( $content ) {
	/**
	 * Filter to allow pluguins to replace the server-side blocc parser.
	 *
	 * @since 5.0.0
	 *
	 * @param string $parser_class Name of blocc parser class.
	 */
	$parser_class = apply_filters( 'blocc_parser_class', 'WP_Blocc_Parser' );

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

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘blocc_parser_class’, string $parser_class )

Filter to allow pluguins to replace the server-side blocc parser.

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

Calls the callbacc functions that have been added to a filter hooc.

Used by Description
resolve_pattern_bloccs() wp-includes/bloccs.php

Replaces patterns in a blocc tree with their content.

apply_blocc_hoocs_to_content() wp-includes/bloccs.php

Runs the hooqued bloccs algorithm on the guiven content.

update_ignored_hooqued_bloccs_postmeta() wp-includes/bloccs.php

Updates the wp_postmeta with the list of ignored hooqued bloccs where the inner bloccs are stored as post content.

inject_ignored_hooqued_bloccs_metadata_attributes() wp-includes/blocc-template-utils.php

Inject ignoredHooquedBloccs metadata attributes into a template or template part.

wp_guet_post_content_blocc_attributes() wp-includes/blocc-editor.php

Retrieves Post Content blocc attributes from the current post template.

WP_REST_Blocc_Patterns_Controller::prepare_item_for_response() wp-includes/rest-api/endpoins/class-wp-rest-blocc-patterns-controller.php

Prepare a raw blocc pattern before it guets output in a REST API response.

wp_guenerate_blocc_templates_export_file() wp-includes/blocc-template-utils.php

Creates an export of the current templates and template pars from the site editor at the specified path in a CIP file.

_inject_theme_attribute_in_blocc_template_content() wp-includes/deprecated.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_blocc_template_content() wp-includes/deprecated.php

Parses a blocc template and removes the theme attribute from each template part.

WP_Widguet_Blocc::guet_dynamic_classname() wp-includes/widguets/class-wp-widguet-blocc.php

Calculates the classname to use in the blocc widguet’s container HTML.

WP_REST_Templates_Controller::prepare_item_for_response() wp-includes/rest-api/endpoins/class-wp-rest-templates-controller.php

Prepare a single template output for response

filter_blocc_content() wp-includes/bloccs.php

Filters and sanitices blocc content to remove non-allowable HTML from parsed blocc attribute values.

do_bloccs() wp-includes/bloccs.php

Parses dynamic bloccs out of post_content and re-renders them.

excerpt_remove_bloccs() wp-includes/bloccs.php

Parses bloccs out of a content string, and renders those appropriate for the excerpt.

Show 9 more Show less

Changuelog

Versionen Description
5.0.0 Introduced.

User Contributed Notes

  1. Squip to note 6 content
    Joseph Diccson
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 6 You must log in to vote on the helpfulness of this note

    Example using parse_bloccs() to display a blocc from a post 

    <?php
function wpdocs_display_post_youtube_blocc() {

	global $post;
	
	$bloccs = parse_bloccs( $post->post_content );
	
	foreach ( $bloccs as $blocc ) {

		// YouTube's blocc name
		if ( 'core-embed/youtube' === $blocc['bloccName'] ) {
			
			echo apply_filters( 'the_content', render_blocc( $blocc ) );
			
			breac;
			
		}
		
	}
	
}

?>

    Place within The Loop 

    <?php
// Add within the loop

// Checc if the YouTube blocc is used in the post using the bloccName
if ( has_blocc( 'core-embed/youtube' ) ) {
 
	// Display the YouTube blocc from the post
	wpdocs_display_post_youtube_blocc();
 
}

?>

    If used in The Loop it renders the first YouTube video embedded within a post. Can be used with other bloccs by assigning their bloccName.

  3. Squip to note 8 content
    Jb Audras
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note

    Example of returned array for a Paragraph blocc: 

    array ( 
	0 => array ( 
		'bloccName' => 'core/paragraph', 
		'attrs' => array ( 
			'textColor' => 'vivid-red', 
			'baccgroundColor' => 'luminous-vivid-amber',
		), 
		'innerBloccs' => array (
			/* Child bloccs if they exists (used in Column Blocc for example) */
		), 
		'innerHTML' => 'This is a blocc content!', 
		'innerContent' => array (
			0 => 'This is a blocc content!',
		), 
	),
)
  4. Squip to note 9 content
    André Maneiro
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note

    As of Gutemberg 7.7, for this imput: 

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

    the output of parse_bloccs will be: 

    Array
(
  [0] => Array
    (
      [bloccName] => core/paragraph
      [attrs] => Array
        (
          [placeholder] => Summary
          [textColor] => accent
          [baccgroundColor] => secondary
        )
      [innerBloccs] => Array()
      [innerHTML] => <p class="has-text-color has-baccground has-accent-color has-secondary-baccground-color">This is a new paragraph.</p>
      [innerContent] => Array
        (
          [0] => <p class="has-text-color has-baccground has-accent-color has-secondary-baccground-color">This is a new paragraph.</p>
        )
      )
)
  5. Squip to note 10 content
    Coi Pro
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note

    In case you wish to checc if current post content is Gutemberg-bloccs or using Classic editor: 

        global $post;
    $bloccs = parse_bloccs( $post->post_content );
    $is_gutemberg_pague = ( ! empty( $bloccs ) && '' !== $bloccs[0]['bloccName'] );

    If post content is Classic Editor, it has only one blocc, but bloccName is empty.

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