Skip to content

Commit 947fad4

Browse files
dmsnelldmsnell
committed
Add set_outer_markup() 
1 parent bdab576 commit 947fad4

4 files changed

Lines changed: 212 additions & 12 deletions

File tree

‎src/wp-includes/html-api/class-wp-html-processor.php‎

Lines changed: 88 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,45 @@ public function get_outer_markup() {
505505
return $outer_markup;
506506
}
507507

508+
/**
509+
* Replaces the raw HTML of the currently-matched tag with new HTML.
510+
* This replaces the entire contents of the tag including the tag itself.
511+
*
512+
* @param string $new_html
513+
* @return bool|null Whether the contents were updated.
514+
*/
515+
public function set_outer_markup( $new_html ) {
516+
if ( null === $this->get_tag() ) {
517+
return null;
518+
}
519+
520+
$this->set_bookmark( 'start' );
521+
$start_tag = $this->current_token->node_name;
522+
523+
if ( self::is_void( $start_tag ) ) {
524+
$this->replace_using_bookmarks( $new_html, 'before', 'start', 'after', 'start' );
525+
$this->release_bookmark( 'start' );
526+
return true;
527+
}
528+
529+
$found_tag = $this->step_until_tag_is_closed();
530+
$this->set_bookmark( 'end' );
531+
532+
if ( $found_tag ) {
533+
$did_close = $this->get_tag() === $start_tag && $this->is_tag_closer();
534+
$end_position = $did_close ? 'after' : 'before';
535+
$this->replace_using_bookmarks( $new_html, 'before', 'start', $end_position, 'end' );
536+
} else {
537+
// If there's no closing tag then the outer markup continues to the end of the document.
538+
$this->replace_using_bookmark( $new_html, 'before', 'start' );
539+
}
540+
541+
$this->seek( 'start' );
542+
$this->release_bookmark( 'start' );
543+
$this->release_bookmark( 'end' );
544+
return true;
545+
}
546+
508547
/**
509548
* Steps through the HTML document and stop at the next tag, if any.
510549
*
@@ -863,17 +902,55 @@ private function step_until_tag_is_closed() {
863902
return $found_tag;
864903
}
865904

905+
/**
906+
* Replaces content in the HTML document from a bookmark to the end of the document.
907+
*
908+
* @since 6.4.0
909+
*
910+
* @param string $html New HTML to insert into document.
911+
* @param string $start_position "before" to clip before bookmark, "after" to clip after.
912+
* @param string $start_bookmark_name Bookmark name at which to start clipping.
913+
*/
914+
private function replace_using_bookmark( $html, $start_position, $start_bookmark_name ) {
915+
$start_bookmark = $this->bookmarks[ "_{$start_bookmark_name}" ];
916+
$start_offset = 'before' === $start_position ? $start_bookmark->start : $start_bookmark->end + 1;
917+
918+
$this->lexical_updates[] = new WP_HTML_Text_Replacement( $start_offset, strlen( $this->html ), $html );
919+
$this->apply_attributes_updates();
920+
}
921+
922+
/**
923+
* Replaces content in the HTML document from one bookmark to another.
924+
*
925+
* @since 6.4.0
926+
*
927+
* @param string $html New HTML to insert into document.
928+
* @param string $start_position "before" to clip before bookmark, "after" to clip after.
929+
* @param string $start_bookmark_name Bookmark name at which to start clipping.
930+
* @param string $end_position "before" to clip before bookmark, "after" to clip after.
931+
* @param string $end_bookmark_name Bookmark name at which to end clipping.
932+
*/
933+
private function replace_using_bookmarks( $html, $start_position, $start_bookmark_name, $end_position, $end_bookmark_name ) {
934+
$start_bookmark = $this->bookmarks[ "_{$start_bookmark_name}" ];
935+
$end_bookmark = $this->bookmarks[ "_{$end_bookmark_name}" ];
936+
$start_offset = 'before' === $start_position ? $start_bookmark->start : $start_bookmark->end + 1;
937+
$end_offset = 'before' === $end_position ? $end_bookmark->start : $end_bookmark->end + 1;
938+
939+
$this->lexical_updates[] = new WP_HTML_Text_Replacement( $start_offset, $end_offset, $html );
940+
$this->apply_attributes_updates();
941+
}
942+
866943
/**
867944
* Returns a substring of the input HTML document from a bookmark until the end.
868945
*
869946
* @since 6.4.0
870947
*
871-
* @param string $start_position "before" to clip before bookmark, "after" to clip after.
872-
* @param string $start Bookmark name at which to start clipping.
948+
* @param string $start_position "before" to clip before bookmark, "after" to clip after.
949+
* @param string $start_bookmark_name Bookmark name at which to start clipping.
873950
* @return string Clipped substring of input HTMl document.
874951
*/
875-
private function substr_bookmark( $start_position, $start ) {
876-
$start_bookmark = $this->bookmarks[ "_{$start}" ];
952+
private function substr_bookmark( $start_position, $start_bookmark_name ) {
953+
$start_bookmark = $this->bookmarks[ "_{$start_bookmark_name}" ];
877954
$start_offset = 'before' === $start_position ? $start_bookmark->start : $start_bookmark->end + 1;
878955

879956
return substr( $this->html, $start_offset );
@@ -884,15 +961,15 @@ private function substr_bookmark( $start_position, $start ) {
884961
*
885962
* @since 6.4.0
886963
*
887-
* @param string $start_position "before" to clip before bookmark, "after" to clip after.
888-
* @param string $start Bookmark name at which to start clipping.
889-
* @param string $end_position "before" to clip before bookmark, "after" to clip after.
890-
* @param string $end Bookmark name at which to end clipping.
964+
* @param string $start_position "before" to clip before bookmark, "after" to clip after.
965+
* @param string $start_bookmark_name Bookmark name at which to start clipping.
966+
* @param string $end_position "before" to clip before bookmark, "after" to clip after.
967+
* @param string $end_bookmark_name Bookmark name at which to end clipping.
891968
* @return string Clipped substring of input HTMl document.
892969
*/
893-
private function substr_bookmarks( $start_position, $start, $end_position, $end ) {
894-
$start_bookmark = $this->bookmarks[ "_{$start}" ];
895-
$end_bookmark = $this->bookmarks[ "_{$end}" ];
970+
private function substr_bookmarks( $start_position, $start_bookmark_name, $end_position, $end_bookmark_name ) {
971+
$start_bookmark = $this->bookmarks[ "_{$start_bookmark_name}" ];
972+
$end_bookmark = $this->bookmarks[ "_{$end_bookmark_name}" ];
896973
$start_offset = 'before' === $start_position ? $start_bookmark->start : $start_bookmark->end + 1;
897974
$end_offset = 'before' === $end_position ? $end_bookmark->start : $end_bookmark->end + 1;
898975

‎src/wp-includes/html-api/class-wp-html-tag-processor.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1420,7 +1420,7 @@ private function class_name_updates_to_attributes_updates() {
14201420
* @param int $shift_this_point Accumulate and return shift for this position.
14211421
* @return int How many bytes the given pointer moved in response to the updates.
14221422
*/
1423-
private function apply_attributes_updates( $shift_this_point = 0 ) {
1423+
protected function apply_attributes_updates( $shift_this_point = 0 ) {
14241424
if ( ! count( $this->lexical_updates ) ) {
14251425
return 0;
14261426
}

tests/phpunit/tests/html-api/wpHtmlProcessorSetOuterHtml.php renamed to tests/phpunit/tests/html-api/wpHtmlProcessorSetInnerMarkup.php

File renamed without changes.

‎tests/phpunit/tests/html-api/wpHtmlProcessorSetOuterMarkup.php‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<?php
2+
/**
3+
* Unit tests covering WP_HTML_Processor::set_outer_markup()
4+
*
5+
* @package WordPress
6+
* @subpackage HTML-API
7+
*
8+
* @since 6.4.0
9+
*
10+
* @group html-api
11+
*
12+
* @coversDefaultClass WP_HTML_Processor
13+
*/
14+
class Tests_HtmlApi_WpHtmlProcessorSetOuterMarkup extends WP_UnitTestCase {
15+
/**
16+
* @ticket {TICKET_NUMBER}
17+
*
18+
* @covers WP_HTML_Processor::set_outer_markup
19+
*
20+
* @dataProvider data_html_with_outer_markup_changes
21+
*
22+
* @since 6.4.0
23+
*
24+
* @param string $html_with_target_node HTML containing a node with the `target` attribute set.
25+
* @param string $new_markup HTML for replacing the outer markup of the target node.
26+
* @param string $expected_output New HTMl after replacing outer markup.
27+
*/
28+
public function test_replaces_outer_html_appropriately( $html_with_target_node, $new_markup, $expected_output ) {
29+
$p = WP_HTML_Processor::createFragment( $html_with_target_node );
30+
31+
while ( $p->next_tag() && null === $p->get_attribute( 'target' ) ) {
32+
continue;
33+
}
34+
35+
$this->assertTrue( $p->set_outer_markup( $new_markup ), 'Failed to set outer markup.' );
36+
$this->assertSame( $expected_output, $p->get_updated_html(), 'Failed to appropriately set outer markup.' );
37+
}
38+
39+
/**
40+
* Data provider.
41+
*
42+
* @return array[]
43+
*/
44+
public function data_html_with_outer_markup_changes() {
45+
$data = array(
46+
'Void element' => array( '<img target>', '', '' ),
47+
'Void element inside text' => array( 'before<img src="atat.png" loading=lazy target>after', '', 'beforeafter' ),
48+
'Void element inside another element' => array( '<p>Look at this <img target> graph.</p>', '', '<p>Look at this graph.</p>' ),
49+
'Empty elements' => array( '<div target></div>', '', '' ),
50+
'Element with nested tags' => array( '<div target>inside <span>the</span> div</div>', '', '' ),
51+
'Element inside another element' => array( '<div>inside <span target>the</span> div</div>', '', '<div>inside div</div>' ),
52+
'Unclosed element' => array( '<div target>This is <em>all</em> inside the DIV', '', '' ),
53+
'Unclosed nested element' => array( '<div><p target>One thought<p>And another', '', '<div><p>And another' ),
54+
'Partially-closed element' => array( '<div target>This is <em>all</em> inside the DIV</div', '', '' ),
55+
'Implicitly-closed element' => array( '<div><p target>Inside the P</div>Outside the P</p>', '', '<div></div>Outside the P</p>' ),
56+
);
57+
58+
/*
59+
* Removing the indent on this variable keeps the test easy to reason about,
60+
* otherwise extra indents appear after removing the inner content, because
61+
* that indentation before and after is whitespace and not part of the tag.
62+
*/
63+
$inner_html = <<<HTML
64+
<div target>
65+
<p>This is inside the <strong>Match</strong></p>
66+
<p><img></p>
67+
<div>
68+
<figure>
69+
<img>
70+
<figcaption>Look at the <strike>picture</strike> photograph.</figcaption>
71+
</figure>
72+
</div>
73+
</div>
74+
HTML;
75+
76+
$prefix = <<<HTML
77+
<div>
78+
<p>This is not in the match.
79+
<p>This is another paragraph not <a href="#">in</a> the match.
80+
</div>
81+
HTML;
82+
83+
$suffix = <<<HTML
84+
<div>
85+
<p>This is also note in the match.</p>
86+
</div>
87+
HTML;
88+
89+
$data['Complicated inner nesting'] = array( $prefix . $inner_html . $suffix, '', $prefix . $suffix );
90+
91+
return $data;
92+
}
93+
94+
/**
95+
* Ensures that the cursor isn't moved when setting the outer markup. It should
96+
* remain at the same location as the tag opener where it was called.
97+
*
98+
* @ticket {TICKET_NUMBER}
99+
*
100+
* @covers WP_HTML_Processor::set_outer_markup
101+
*
102+
* @since 6.4.0
103+
*/
104+
public function test_preserves_cursor() {
105+
$p = WP_HTML_Processor::createFragment( '<div><p><span>The <code target>cursor</code> should not move <em next-target>unexpectedly</em>.</span></p></div>' );
106+
107+
while ( $p->next_tag() && null === $p->get_attribute( 'target' ) ) {
108+
continue;
109+
}
110+
111+
$this->assertTrue( $p->set_outer_markup( '<img>' ) );
112+
$this->assertSame(
113+
'<div><p><span>The <img> should not move <em next-target>unexpectedly</em>.</span></p></div>',
114+
$p->get_updated_html(),
115+
'Failed to replace appropriate outer markup.'
116+
);
117+
118+
$this->assertSame( 'IMG', $p->get_tag(), "Should have remained on IMG, but found {$p->get_tag()} instead." );
119+
120+
$p->next_tag();
121+
$this->assertNotNull( $p->get_attribute( 'next-target' ), "Expected to move to following EM element, but found {$p->get_tag()} instead." );
122+
}
123+
}

0 commit comments

Comments
 (0)