Skip to content

Commit 5972561

Browse files
dmsnelldmsnell
committed
Add set_inner_markup()
1 parent 7358023 commit 5972561

2 files changed

Lines changed: 190 additions & 23 deletions

File tree

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

Lines changed: 67 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -497,20 +497,20 @@ public function get_raw_inner_markup() {
497497
return null;
498498
}
499499

500-
$this->set_bookmark( 'start' );
500+
$this->set_bookmark( 'opener' );
501501
$found_tag = $this->step_until_tag_is_closed();
502-
$this->set_bookmark( 'end' );
502+
$this->set_bookmark( 'closer' );
503503

504504
if ( $found_tag ) {
505-
$inner_markup = $this->substr_bookmarks( 'after', 'start', 'before', 'end' );
505+
$inner_markup = $this->substr_bookmarks( 'after', 'opener', 'before', 'closer' );
506506
} else {
507507
// If there's no closing tag then the inner markup continues to the end of the document.
508-
$inner_markup = $this->substr_bookmark( 'after', 'start' );
508+
$inner_markup = $this->substr_bookmark( 'after', 'opener' );
509509
}
510510

511-
$this->seek( 'start' );
512-
$this->release_bookmark( 'start' );
513-
$this->release_bookmark( 'end' );
511+
$this->seek( 'opener' );
512+
$this->release_bookmark( 'opener' );
513+
$this->release_bookmark( 'closer' );
514514

515515
return $inner_markup;
516516
}
@@ -539,31 +539,75 @@ public function get_raw_outer_markup() {
539539
return null;
540540
}
541541

542-
$this->set_bookmark( 'start' );
542+
$this->set_bookmark( 'opener' );
543543
$start_tag = $this->current_token->node_name;
544544
$found_tag = $this->step_until_tag_is_closed();
545-
$this->set_bookmark( 'end' );
545+
$this->set_bookmark( 'closer' );
546546

547547
if ( $found_tag ) {
548548
$did_close = $this->get_tag() === $start_tag && $this->is_tag_closer();
549549
$end_position = $did_close ? 'after' : 'before';
550-
$outer_markup = $this->substr_bookmarks( 'before', 'start', $end_position, 'end' );
550+
$outer_markup = $this->substr_bookmarks( 'before', 'opener', $end_position, 'closer' );
551551
} else {
552552
// If there's no closing tag then the outer markup continues to the end of the document.
553-
$outer_markup = $this->substr_bookmark( 'before', 'start' );
553+
$outer_markup = $this->substr_bookmark( 'before', 'opener' );
554554
}
555555

556-
$this->seek( 'start' );
557-
$this->release_bookmark( 'start' );
558-
$this->release_bookmark( 'end' );
556+
$this->seek( 'opener' );
557+
$this->release_bookmark( 'opener' );
558+
$this->release_bookmark( 'closer' );
559559

560560
return $outer_markup;
561561
}
562562

563+
/**
564+
* Replaces the raw HTML of the currently-matched tag's inner markup with new HTML.
565+
* This replaces the content between the tag opener and tag closer.
566+
*
567+
* @throws Exception When unable to set bookmark for internal tracking.
568+
*
569+
* @since 6.4.0
570+
*
571+
* @param string $new_html
572+
* @return bool|null Whether the contents were updated.
573+
*/
574+
public function set_raw_inner_markup( $new_html ) {
575+
if ( null === $this->get_tag() ) {
576+
return null;
577+
}
578+
579+
$this->set_bookmark( 'opener' );
580+
$start_tag = $this->current_token->node_name;
581+
582+
if ( self::is_void( $start_tag ) ) {
583+
$this->release_bookmark( 'opener' );
584+
return true;
585+
}
586+
587+
$found_tag = $this->step_until_tag_is_closed();
588+
$this->set_bookmark( 'closer' );
589+
590+
if ( $found_tag ) {
591+
$this->replace_using_bookmarks( $new_html, 'after', 'opener', 'before', 'closer' );
592+
} else {
593+
// If there's no closing tag then the inner markup continues to the end of the document.
594+
$this->replace_using_bookmark( $new_html, 'after', 'opener' );
595+
}
596+
597+
$this->seek( 'opener' );
598+
$this->release_bookmark( 'opener' );
599+
$this->release_bookmark( 'closer' );
600+
return true;
601+
}
602+
563603
/**
564604
* Replaces the raw HTML of the currently-matched tag with new HTML.
565605
* This replaces the entire contents of the tag including the tag itself.
566606
*
607+
* @throws Exception When unable to set bookmark for internal tracking.
608+
*
609+
* @since 6.4.0
610+
*
567611
* @param string $new_html
568612
* @return bool|null Whether the contents were updated.
569613
*/
@@ -572,30 +616,30 @@ public function set_raw_outer_markup( $new_html ) {
572616
return null;
573617
}
574618

575-
$this->set_bookmark( 'start' );
619+
$this->set_bookmark( 'opener' );
576620
$start_tag = $this->current_token->node_name;
577621

578622
if ( self::is_void( $start_tag ) ) {
579-
$this->replace_using_bookmarks( $new_html, 'before', 'start', 'after', 'start' );
580-
$this->release_bookmark( 'start' );
623+
$this->replace_using_bookmarks( $new_html, 'before', 'opener', 'after', 'opener' );
624+
$this->release_bookmark( 'opener' );
581625
return true;
582626
}
583627

584628
$found_tag = $this->step_until_tag_is_closed();
585-
$this->set_bookmark( 'end' );
629+
$this->set_bookmark( 'closer' );
586630

587631
if ( $found_tag ) {
588632
$did_close = $this->get_tag() === $start_tag && $this->is_tag_closer();
589633
$end_position = $did_close ? 'after' : 'before';
590-
$this->replace_using_bookmarks( $new_html, 'before', 'start', $end_position, 'end' );
634+
$this->replace_using_bookmarks( $new_html, 'before', 'opener', $end_position, 'closer' );
591635
} else {
592636
// If there's no closing tag then the outer markup continues to the end of the document.
593-
$this->replace_using_bookmark( $new_html, 'before', 'start' );
637+
$this->replace_using_bookmark( $new_html, 'before', 'opener' );
594638
}
595639

596-
$this->seek( 'start' );
597-
$this->release_bookmark( 'start' );
598-
$this->release_bookmark( 'end' );
640+
$this->seek( 'opener' );
641+
$this->release_bookmark( 'opener' );
642+
$this->release_bookmark( 'closer' );
599643
return true;
600644
}
601645

‎tests/phpunit/tests/html-api/wpHtmlProcessorSetInnerMarkup.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_raw_inner_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_WpHtmlProcessorSetInnerMarkup extends WP_UnitTestCase {
15+
/**
16+
* @ticket {TICKET_NUMBER}
17+
*
18+
* @covers WP_HTML_Processor::set_raw_inner_markup
19+
*
20+
* @dataProvider data_html_with_inner_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 inner markup of the target node.
26+
* @param string $expected_output New HTMl after replacing inner markup.
27+
*/
28+
public function test_replaces_inner_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_raw_inner_markup( $new_markup ), 'Failed to set inner markup.' );
36+
$this->assertSame( $expected_output, $p->get_updated_html(), 'Failed to appropriately set inner markup.' );
37+
}
38+
39+
/**
40+
* Data provider.
41+
*
42+
* @return array[]
43+
*/
44+
public function data_html_with_inner_markup_changes() {
45+
$data = array(
46+
'Void element' => array( '<img target>', '', '<img target>' ),
47+
'Void element inside text' => array( 'before<img src="atat.png" loading=lazy target>after', '', 'before<img src="atat.png" loading=lazy target>after' ),
48+
'Void element inside another element' => array( '<p>Look at this <img target> graph.</p>', '', '<p>Look at this <img target> graph.</p>' ),
49+
'Empty elements' => array( '<div target></div>', '', '<div target></div>' ),
50+
'Element with nested tags' => array( '<div target>inside <span>the</span> div</div>', '', '<div target></div>' ),
51+
'Element inside another element' => array( '<div>inside <span target>the</span> div</div>', '', '<div>inside <span target></span> div</div>' ),
52+
'Unclosed element' => array( '<div target>This is <em>all</em> inside the DIV', '', '<div target>' ),
53+
'Unclosed nested element' => array( '<div><p target>One thought<p>And another', '', '<div><p target><p>And another' ),
54+
'Partially-closed element' => array( '<div target>This is <em>all</em> inside the DIV</div', '', '<div target>' ),
55+
'Implicitly-closed element' => array( '<div><p target>Inside the P</div>Outside the P</p>', '', '<div><p target></div>Outside the P</p>' ),
56+
);
57+
58+
$inner_html = <<<HTML
59+
<p>This is inside the <strong>Match</strong></p>
60+
<p><img></p>
61+
<div>
62+
<figure>
63+
<img>
64+
<figcaption>Look at the <strike>picture</strike> photograph.</figcaption>
65+
</figure>
66+
</div>
67+
HTML;
68+
69+
$prefix = <<<HTML
70+
<div>
71+
<p>This is not in the match.
72+
<p>This is another paragraph not <a href="#">in</a> the match.
73+
</div>
74+
<div target>
75+
HTML;
76+
77+
/*
78+
* Removing the indent on this first line keeps the test easy to reason about,
79+
* otherwise extra indents appear after removing the inner content, because
80+
* that indentation before and after is whitespace and not part of the tag.
81+
*/
82+
$suffix = <<<HTML
83+
</div>
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 inner 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_raw_inner_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_raw_inner_markup( '<img next-target>' ) );
112+
$this->assertSame(
113+
'<div><p><span>The <code target><img next-target></code> should not move <em next-target>unexpectedly</em>.</span></p></div>',
114+
$p->get_updated_html(),
115+
'Failed to replace appropriate inner markup.'
116+
);
117+
118+
$this->assertSame( 'CODE', $p->get_tag(), "Should have remained on CODE, but found {$p->get_tag()} instead." );
119+
120+
$p->next_tag();
121+
$this->assertNotNull( $p->get_attribute( 'next-target' ), "Expected to move to inserted IMG element, but found {$p->get_tag()} instead." );
122+
}
123+
}

0 commit comments

Comments
 (0)