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.

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

Block Bindings: Add support to image caption attribute in block bindings #61255

Open
wants to merge 39 commits into
base: trunk
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
6939eb5
Add support in the JS hook
SantosGuillamot Jul 1, 2024
33ebfd8
Add support in the PHP array
SantosGuillamot Jul 1, 2024
1539bb5
Transform figure > a selector into a
SantosGuillamot Jul 1, 2024
47bac8c
Modify the image rendering if bindings are set
SantosGuillamot Jul 1, 2024
841165d
Add support for image caption
SantosGuillamot Jul 1, 2024
31a78b8
Adapt Gutenberg compatibility filters
SantosGuillamot Jul 1, 2024
2abb001
Use regex (temporary)
SantosGuillamot Jul 1, 2024
49f327c
Fix regex
SantosGuillamot Jul 1, 2024
c85de98
Another approach: Remove tags in render
SantosGuillamot Jul 1, 2024
f69662d
Update supported binding attribtues in another file
talldan Jul 1, 2024
d1734c5
Update client side pattern override supported attributes
talldan Jul 1, 2024
953eea5
Add `set_inner_text` private method instead of using regex
SantosGuillamot Jul 1, 2024
7f00489
Support only caption
SantosGuillamot Jul 1, 2024
cac2dd1
Only run `set_inner_text` when figcaption exists
SantosGuillamot Jul 1, 2024
fd58bcf
Go back to existing `save.js`
SantosGuillamot Jul 1, 2024
c5abad9
Fix typo
SantosGuillamot Jul 1, 2024
3a9c6e8
Remove comment
SantosGuillamot Jul 1, 2024
01ca7ee
Hide caption controls if the caption is binded
cbravobernal Jul 1, 2024
2967e88
Remove user permissions check
cbravobernal Jul 1, 2024
ec0e52c
Add caption e2e tests
SantosGuillamot Jul 1, 2024
fa01364
Copy latest changes from core
SantosGuillamot Jul 1, 2024
f39fa0b
Remove extra return
SantosGuillamot Jul 1, 2024
45cd9e4
Fix bookmarks
SantosGuillamot Jul 1, 2024
da0886d
Fix compatibility with older versions
SantosGuillamot Jul 1, 2024
75fc917
Move logic to 6.6 compat folder
SantosGuillamot Jul 1, 2024
0fe9b31
Only process image caption in 6.6 compat
SantosGuillamot Jul 1, 2024
435058e
Remove extra spaces
SantosGuillamot Jul 1, 2024
895110a
Don't grab bookmarks until the end
SantosGuillamot Jul 1, 2024
3e183b7
Remove release_bookmark
SantosGuillamot Jul 1, 2024
a2b825c
Add warning
SantosGuillamot Jul 1, 2024
77d7116
Make filter caption specific
SantosGuillamot Jul 1, 2024
dc568a9
Only process caption in WP 6.5
SantosGuillamot Jul 1, 2024
6eeb7c2
Change conditional
SantosGuillamot Jul 1, 2024
0e3b174
Add support for 6.4
SantosGuillamot Jul 1, 2024
7311680
Clarify methods only apply to figcaption
SantosGuillamot Jul 1, 2024
d38d635
Remove check to always run caption processing
SantosGuillamot Jul 1, 2024
586d7df
Add backport changelog
SantosGuillamot Jul 1, 2024
ac597ee
Move changelog to 6.7 folder
SantosGuillamot Jul 1, 2024
be4c4c2
Remove caption restriction in pattern overrides
SantosGuillamot Jul 1, 2024
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Copy latest changes from core
  • Loading branch information
SantosGuillamot committed Jul 1, 2024
commit fa013642a42fc24c4d1d36925a0031fa317d0da4
88 changes: 58 additions & 30 deletions lib/compat/wordpress-6.5/blocks.php
talldan marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -67,45 +67,73 @@ function gutenberg_block_bindings_replace_html( $block_content, $block_name, str
switch ( $block_type->attributes[ $attribute_name ]['source'] ) {
case 'html':
case 'rich-text':
// Create private anonymous class because the HTML API doesn't support `set_inner_html` method yet.
$block_reader = new class($block_content) extends WP_HTML_Tag_Processor{
public function gutenberg_set_inner_text( $new_content ) {
$tag_name = $this->get_tag();
// Get position of the opener tag.
$this->set_bookmark( 'opener_tag' );
$opener_tag_bookmark = $this->bookmarks['opener_tag'];

// Visit the closing tag.
if ( ! $this->next_tag(
array(
'tag_name' => $tag_name,
'tag_closers' => 'visit',
)
) || ! $this->is_tag_closer() ) {
$this->release_bookmark( 'opener_tag' );
return null;
}
if ( 'core/image' === $block_name && 'caption' === $attribute_name ) {
SantosGuillamot marked this conversation as resolved.
Show resolved Hide resolved
// Create private anonymous class until the HTML API provides `set_inner_html` method.
$block_reader = new class($block_content) extends WP_HTML_Tag_Processor{
/**
* Replace the inner text of an HTML with the passed content.
*
* THIS IS A TEMPORARY SOLUTION IN CORE NOT TO BE EMULATED.
* IT IS A TEMPORARY SOLUTION THAT JUST WORKS FOR THIS SPECIFIC
* USE CASE UNTIL THE HTML PROCESSOR PROVIDES ITS OWN METHOD.
*
* @param string $new_content New text to insert in the HTML element.
* @return bool Whether the inner text was properly replaced.
*/
public function gutenberg_set_inner_text( $new_content ) {
return;
/*
* THIS IS A STOP-GAP MEASURE NOT TO BE EMULATED.
*
* Check that the processor is paused on an opener tag.
*
*/
if (
WP_HTML_Tag_Processor::STATE_MATCHED_TAG !== $this->parser_state ||
$this->is_tag_closer()
) {
return false;
}

// Get position of the closer tag.
$closer_tag_bookmark = $this->set_bookmark( 'closer_tag' );
$closer_tag_bookmark = $this->bookmarks['closer_tag'];
// Set position of the opener tag.
$this->set_bookmark( 'opener_tag' );

/*
* This is a best-effort guess to visit the closer tag and check it exists.
* In the future, this code should rely on the HTML Processor for this kind of operation.
*/
$tag_name = $this->get_tag();
if ( ! $this->next_tag(
array(
'tag_name' => $tag_name,
'tag_closers' => 'visit',
)
) || ! $this->is_tag_closer() ) {
return false;
}

// Appends the new content.
$after_opener_tag = $opener_tag_bookmark->start + $opener_tag_bookmark->length;
$inner_content_length = $closer_tag_bookmark->start - $after_opener_tag;
$this->lexical_updates[] = new WP_HTML_Text_Replacement( $after_opener_tag, $inner_content_length, $new_content );
$this->release_bookmark( 'opener_tag' );
$this->release_bookmark( 'closer_tag' );
}
};
// Set position of the closer tag.
$this->set_bookmark( 'closer_tag' );

if ( 'core/image' === $block_name && 'caption' === $attribute_name ) {
// Get opener and closer tag bookmarks.
$opener_tag_bookmark = $this->bookmarks['_opener_tag'];
$closer_tag_bookmark = $this->bookmarks['_closer_tag'];

// Appends the new content.
$after_opener_tag = $opener_tag_bookmark->start + $opener_tag_bookmark->length;
$inner_content_length = $closer_tag_bookmark->start - $after_opener_tag;
$this->lexical_updates[] = new WP_HTML_Text_Replacement( $after_opener_tag, $inner_content_length, $new_content );
return true;
}
};
if ( $block_reader->next_tag( 'figcaption' ) ) {
$block_reader->gutenberg_set_inner_text( wp_kses_post( $source_value ) );
}
return $block_reader->get_updated_html();
}

$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'] );
Expand Down