wp-block-converter's Introduction

WP Block Converter

Convert HTML into Gutenberg Blocks with PHP

Installation

You can install the package via composer:

composer require alleyinteractive/wp-block-converter

Usage

Use this package like so to convert HTML into Gutenberg Blocks:

use Alley\WP\Block_Converter\Block_Converter;

$converter = new Block_Converter( '<p>Some HTML</p>' );

$blocks = $converter->convert();

Filtering the Blocks

The blocks can be filtered on a block-by-block basis or for an entire HTML body.

`wp_block_converter_block`

Filter the generated block for a specific node.

use Alley\WP\Block_Converter\Block;

add_filter( 'wp_block_converter_block', function ( Block $block, \DOMElement $node ): ?Block {
	// Modify the block before it is serialized.
	$block->content = '...';
	$block->blockName = '...';
	$block->attributes = [ ... ];

	return $block;
}, 10, 2 );

`wp_block_converter_document_html`

Filter the generated blocks for an entire HTML body.

add_filter( 'wp_block_converter_document_html', function( string $blocks, \DOMNodeList $content ): string {
	// ...
	return $blocks;
}, 10, 2 );

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

This project is actively maintained by Alley Interactive. Like what you see? Come work with us.

License

The GNU General Public License (GPL) license. Please see License File for more information.

wp-block-converter's People

Contributors

Stargazers

Watchers

wp-block-converter's Issues

Use a list item block for 6.1

WordPress/gutenberg#42711

Some block conversion issues identified

Description

First, thank you for this library, it's an awesome idea.

Working with it, I identified some minor issues dealing with images:

Function upload_image should return an URL, but instead is returning an attachment ID
remove_image_args has issues when the image URLs have formats such as //domain.../image, http://localhost:8888, which can be an issue when working with some CDNs or local development environments, for example.
The converter method img might fail, and the return would be WP_Error, and maybe a try-catch would be useful.
the Block constructor requires block_name to be of type string but the WordPress Core function get_comment_delimited_block_content can receive null as block_name, where the block content would be returned.

Use Case

As mentioned, the source images might have URLs with format //domain.../image, http://localhost:8888/.../image but remove_image_args would fail.

If the Blocks constructor accepted block_name as null, it would be possible to return a group of blocks directly, for example to return the blocks from a registered pattern.

Recommend Projects