<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58298] trunk/src/wp-includes/class-wp-block.php: Editor: Simplify the block bindings HTML replacement logic until the HTML API is ready.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58298">58298</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58298","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-03 16:12:00 +0000 (Mon, 03 Jun 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Editor: Simplify the block bindings HTML replacement logic until the HTML API is ready.
This changeset modifies the block bindings HTML replacement logic to use a hardcoded list of selectors based on the block and a regex to substitute the inner content. The previous logic was too complex because the HTML API does not support CSS selectors yet and it does not have an official way to modify the inner HTML. This made it difficult to understand, iterate on it and add new functionalities.
As it will be solved in the future once the HTML API is ready, it is better for now to keep a simple hardcoded version that is easier to understand and iterate on.
Props santosguillamot, gziolo, petitphp.
Fixes <a href="https://core.trac.wordpress.org/ticket/61351">#61351</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpblockphp">trunk/src/wp-includes/class-wp-block.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpblockphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-block.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-block.php 2024-06-03 15:42:37 UTC (rev 58297)
+++ trunk/src/wp-includes/class-wp-block.php 2024-06-03 16:12:00 UTC (rev 58298)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -333,68 +333,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $block_type->attributes[ $attribute_name ]['source'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'html':
</span><span class="cx" style="display: block; padding: 0 10px"> case 'rich-text':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $block_reader = new WP_HTML_Tag_Processor( $block_content );
-
- // TODO: Support for CSS selectors whenever they are ready in the HTML API.
- // In the meantime, support comma-separated selectors by exploding them into an array.
- $selectors = explode( ',', $block_type->attributes[ $attribute_name ]['selector'] );
- // Add a bookmark to the first tag to be able to iterate over the selectors.
- $block_reader->next_tag();
- $block_reader->set_bookmark( 'iterate-selectors' );
-
- // TODO: This shouldn't be needed when the `set_inner_html` function is ready.
- // Store the parent tag and its attributes to be able to restore them later in the button.
- // The button block has a wrapper while the paragraph and heading blocks don't.
- if ( 'core/button' === $this->name ) {
- $button_wrapper = $block_reader->get_tag();
- $button_wrapper_attribute_names = $block_reader->get_attribute_names_with_prefix( '' );
- $button_wrapper_attrs = array();
- foreach ( $button_wrapper_attribute_names as $name ) {
- $button_wrapper_attrs[ $name ] = $block_reader->get_attribute( $name );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Hardcode the selectors and processing until the HTML API is able to read CSS selectors and replace inner HTML.
+ // TODO: Use the HTML API instead.
+ if ( 'core/paragraph' === $this->name && 'content' === $attribute_name ) {
+ $selector = 'p';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- foreach ( $selectors as $selector ) {
- // If the parent tag, or any of its children, matches the selector, replace the HTML.
- if ( strcasecmp( $block_reader->get_tag( $selector ), $selector ) === 0 || $block_reader->next_tag(
- array(
- 'tag_name' => $selector,
- )
- ) ) {
- $block_reader->release_bookmark( 'iterate-selectors' );
-
- // TODO: Use `set_inner_html` method whenever it's ready in the HTML API.
- // Until then, it is hardcoded for the paragraph, heading, and button blocks.
- // Store the tag and its attributes to be able to restore them later.
- $selector_attribute_names = $block_reader->get_attribute_names_with_prefix( '' );
- $selector_attrs = array();
- foreach ( $selector_attribute_names as $name ) {
- $selector_attrs[ $name ] = $block_reader->get_attribute( $name );
- }
- $selector_markup = "<$selector>" . wp_kses_post( $source_value ) . "</$selector>";
- $amended_content = new WP_HTML_Tag_Processor( $selector_markup );
- $amended_content->next_tag();
- foreach ( $selector_attrs as $attribute_key => $attribute_value ) {
- $amended_content->set_attribute( $attribute_key, $attribute_value );
- }
- if ( 'core/paragraph' === $this->name || 'core/heading' === $this->name ) {
- return $amended_content->get_updated_html();
- }
- if ( 'core/button' === $this->name ) {
- $button_markup = "<$button_wrapper>{$amended_content->get_updated_html()}</$button_wrapper>";
- $amended_button = new WP_HTML_Tag_Processor( $button_markup );
- $amended_button->next_tag();
- foreach ( $button_wrapper_attrs as $attribute_key => $attribute_value ) {
- $amended_button->set_attribute( $attribute_key, $attribute_value );
- }
- return $amended_button->get_updated_html();
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'core/heading' === $this->name && 'content' === $attribute_name ) {
+ $selector = 'h[1-6]';
+ }
+ if ( 'core/button' === $this->name && 'text' === $attribute_name ) {
+ // Check if it is a <button> or <a> tag.
+ if ( preg_match( '/<button[^>]*>.*?<\/button>/', $block_content ) ) {
+ $selector = 'button';
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $block_reader->seek( 'iterate-selectors' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $selector = 'a';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $block_reader->release_bookmark( 'iterate-selectors' );
- return $block_content;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $selector ) ) {
+ return $block_content;
+ }
+ $pattern = '/(<' . $selector . '[^>]*>).*?(<\/' . $selector . '>)/i';
+ return preg_replace( $pattern, '$1' . wp_kses_post( $source_value ) . '$2', $block_content );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'attribute':
</span><span class="cx" style="display: block; padding: 0 10px"> $amended_content = new WP_HTML_Tag_Processor( $block_content );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -408,13 +367,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $amended_content->set_attribute( $block_type->attributes[ $attribute_name ]['attribute'], $source_value );
</span><span class="cx" style="display: block; padding: 0 10px"> return $amended_content->get_updated_html();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- break;
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> default:
</span><span class="cx" style="display: block; padding: 0 10px"> return $block_content;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- break;
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>