Skip to content

Commit

Permalink
Clarify methods only apply to figcaption
Browse files Browse the repository at this point in the history
  • Loading branch information
@SantosGuillamot
SantosGuillamot committed Jun 20, 2024
1 parent ad56819 commit fcf2abc
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 23 deletions.
36 changes: 22 additions & 14 deletions lib/compat/wordpress-6.6/blocks.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ function gutenberg_block_bindings_replace_caption( $block_content, $block_name,
*/

/**
* Replace the inner text of an HTML with the passed content.
* Replace the inner content of a figcaption element with the passed content.
*
* @param string $new_content New text to insert in the HTML element.
* @return bool Whether the inner text was properly replaced.
* @param string $new_content New content to insert in the figcaption element.
* @return bool Whether the inner content was properly replaced.
*/
public function gutenberg_set_inner_text( $new_content ) {
public function gutenberg_set_content_between_figcaption_balanced_tags( $new_content ) {
// Check that the processor is paused on an opener tag.
if ( $this->is_tag_closer() ) {
if ( $this->is_tag_closer() || 'FIGCAPTION' !== $this->get_tag() ) {
return false;
}

Expand Down Expand Up @@ -123,13 +123,17 @@ public function gutenberg_set_inner_text( $new_content ) {
}

/**
* Add a new HTML element after the current tag.
* Add a new figcaption element after the `img` or `a` tag.
*
* @param string $new_element New HTML element to append after the current tag.
* @param string $new_element New figcaption element to append after the tag.
* @return bool Whether the element was properly appended.
*/
public function gutenberg_append_element_after_tag( $new_element ) {
public function gutenberg_append_figcaption_element_after_tag( $new_element ) {
$tag_name = $this->get_tag();
// Ensure figcaption is only added in the correct place.
if ( 'IMG' !== $tag_name && 'A' !== $tag_name ) {
return false;
}
$this->set_bookmark( 'current_tag' );
// Visit the closing tag if exists.
if ( ! $this->next_tag(
Expand Down Expand Up @@ -166,16 +170,20 @@ public function gutenberg_append_element_after_tag( $new_element ) {
}

/**
* Remove the current tag element.
* Remove the current figcaption tag element.
*
* @return bool Whether the element was properly removed.
*/
public function gutenberg_remove_current_tag_element() {
public function gutenberg_remove_figcaption_tag_element() {
$tag_name = $this->get_tag();
// Ensure only figcaption is removed.
if ( 'FIGCAPTION' !== $tag_name ) {
return false;
}
// Set position of the opener tag.
$this->set_bookmark( 'opener_tag' );

// Visit the closing tag.
$tag_name = $this->get_tag();
if ( ! $this->next_tag(
array(
'tag_name' => $tag_name,
Expand Down Expand Up @@ -228,17 +236,17 @@ public function gutenberg_remove_current_tag_element() {

if ( $block_reader->next_tag( 'figcaption' ) ) {
if ( empty( $new_value ) ) {
$block_reader->gutenberg_remove_current_tag_element();
$block_reader->gutenberg_remove_figcaption_tag_element();
} else {
$block_reader->gutenberg_set_inner_text( $new_value );
$block_reader->gutenberg_set_content_between_figcaption_balanced_tags( $new_value );
}
} else {
$block_reader->seek( 'figure' );
if ( ! $block_reader->next_tag( 'a' ) ) {
$block_reader->seek( 'figure' );
$block_reader->next_tag( 'img' );
}
$block_reader->gutenberg_append_element_after_tag( '<figcaption class="wp-element-caption">' . $new_value . '</figcaption>' );
$block_reader->gutenberg_append_figcaption_element_after_tag( '<figcaption class="wp-element-caption">' . $new_value . '</figcaption>' );
}

return $block_reader->get_updated_html();
Expand Down
28 changes: 19 additions & 9 deletions packages/block-library/src/image/index.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,17 @@ function render_block_core_image( $attributes, $content, $block ) {
*/

/**
* Add a new HTML element after the current tag.
* Add a new figcaption element after the `img` or `a` tag.
*
* @param string $new_element New HTML element to append after the current tag.
* @param string $new_element New figcaption element to append after the tag.
* @return bool Whether the element was properly appended.
*/
public function append_element_after_tag( $new_element ) {
public function append_figcaption_element_after_tag( $new_element ) {
$tag_name = $this->get_tag();
// Ensure figcaption is only added in the correct place.
if ( 'IMG' !== $tag_name && 'A' !== $tag_name ) {
return false;
}
$this->set_bookmark( 'current_tag' );
// Visit the closing tag if exists.
if ( ! $this->next_tag(
Expand Down Expand Up @@ -70,19 +75,24 @@ public function append_element_after_tag( $new_element ) {

// Append the new element.
$this->lexical_updates[] = new WP_HTML_Text_Replacement( $after_closer_tag, 0, $new_element );
return true;
}

/**
* Remove the current tag element.
* Remove the current figcaption tag element.
*
* @return bool Whether the element was properly removed.
*/
public function remove_current_tag_element() {
public function remove_figcaption_tag_element() {
$tag_name = $this->get_tag();
// Ensure only figcaption is removed.
if ( 'FIGCAPTION' !== $tag_name ) {
return false;
}
// Set position of the opener tag.
$this->set_bookmark( 'opener_tag' );

// Visit the closing tag.
$tag_name = $this->get_tag();
if ( ! $this->next_tag(
array(
'tag_name' => $tag_name,
Expand All @@ -95,7 +105,7 @@ public function remove_current_tag_element() {
// Set position of the closer tag.
$this->set_bookmark( 'closer_tag' );

// Get tag positions.
// Get position of the tags.
$opener_tag_bookmark = $this->bookmarks['opener_tag'];
$closer_tag_bookmark = $this->bookmarks['closer_tag'];

Expand Down Expand Up @@ -180,7 +190,7 @@ public function remove_current_tag_element() {
if ( $p->next_tag( 'figcaption' ) ) {
// Remove `<figcaption>` if exists and caption attribute exists but it is empty.
if ( isset( $attributes['caption'] ) && strlen( $attributes['caption'] ) === 0 ) {
$p->remove_current_tag_element();
$p->remove_figcaption_tag_element();
}
} else {
// Add caption if it doesn't exist and the caption is not empty.
Expand All @@ -191,7 +201,7 @@ public function remove_current_tag_element() {
$p->seek( 'figure' );
$p->next_tag( 'img' );
}
$p->append_element_after_tag( '<figcaption class="wp-element-caption">' . $attributes['caption'] . '</figcaption>' );
$p->append_figcaption_element_after_tag( '<figcaption class="wp-element-caption">' . $attributes['caption'] . '</figcaption>' );
}
}
$p->release_bookmark( 'figure' );
Expand Down

0 comments on commit fcf2abc

Please sign in to comment.