Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve handling of empty blocks #317

Merged
merged 1 commit into from
Dec 4, 2024
Merged

fix: improve handling of empty blocks #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/pink-impalas-divide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@wpengine/wp-graphql-content-blocks": patch
---

fix: improve handling of empty blocks in `ContentBlocksResolver`.
26 changes: 18 additions & 8 deletions includes/Data/ContentBlocksResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,18 @@ public static function resolve_content_blocks( $node, $args, $allowed_block_name
return [];
}

// Parse the blocks from HTML comments to an array of blocks
// Parse the blocks from HTML comments to an array of blocks.
$parsed_blocks = self::parse_blocks( $content );
if ( empty( $parsed_blocks ) ) {
return [];
}

// Flatten block list here if requested or if 'flat' value is not selected (default)
// Flatten block list here if requested or if 'flat' value is not selected (default).
if ( ! isset( $args['flat'] ) || 'true' == $args['flat'] ) { // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
$parsed_blocks = self::flatten_block_list( $parsed_blocks );
}

// Final level of filtering out blocks not in the allowed list
// Final level of filtering out blocks not in the allowed list.
$parsed_blocks = self::filter_allowed_blocks( $parsed_blocks, $allowed_block_names );

/**
Expand Down Expand Up @@ -124,7 +124,7 @@ private static function handle_do_blocks( array $blocks ): array {
}

// Remove empty blocks.
return array_filter( $parsed );
return array_values( array_filter( $parsed ) );
}

/**
Expand Down Expand Up @@ -170,10 +170,13 @@ private static function is_block_empty( array $block ): bool {
return false;
}

// @todo add more checks and avoid using render_block().
// If there is no innerHTML and no innerContent, we can consider it empty.
if ( empty( $block['innerHTML'] ) && empty( $block['innerContent'] ) ) {
return true;
}

// Strip empty comments and spaces
$stripped = preg_replace( '/<!--(.*)-->/Uis', '', render_block( $block ) );
// Strip empty comments and spaces to see if `innerHTML` is truly empty.
$stripped = preg_replace( '/<!--(.*)-->/Uis', '', $block['innerHTML'] );

return empty( trim( $stripped ?? '' ) );
}
Expand Down Expand Up @@ -208,7 +211,9 @@ private static function populate_reusable_blocks( array $block ): array {
/**
* Flattens a list blocks into a single array
*
* @param array $blocks A list of blocks to flatten.
* @param array<string,mixed> $blocks A list of blocks to flatten.
*
* @return array<string,mixed> The flattened list of blocks.
*/
private static function flatten_block_list( $blocks ): array {
$result = [];
Expand All @@ -222,6 +227,8 @@ private static function flatten_block_list( $blocks ): array {
* Flattens a block and its inner blocks into a single while attaching unique clientId's
*
* @param array<string,mixed> $block A parsed block.
*
* @return array<string,mixed> The flattened block.
*/
private static function flatten_inner_blocks( $block ): array {
$result = [];
Expand All @@ -237,6 +244,7 @@ private static function flatten_inner_blocks( $block ): array {
$result = array_merge( $result, self::flatten_inner_blocks( $child ) );
}

/** @var array<string,mixed> $result */
return $result;
}

Expand All @@ -245,6 +253,8 @@ private static function flatten_inner_blocks( $block ): array {
*
* @param array<string,mixed> $blocks A list of blocks to filter.
* @param string[] $allowed_block_names The list of allowed block names to filter.
*
* @return array<string,mixed> The filtered list of blocks.
*/
private static function filter_allowed_blocks( array $blocks, array $allowed_block_names ): array {
if ( empty( $allowed_block_names ) ) {
Expand Down
Loading