<!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>[55729] branches/6.2/src/wp-includes/html-api/class-wp-html-tag-processor.php: Docs: Update code examples formatting in `WP_HTML_Tag_Processor` documentation.</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/55729">55729</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/55729","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-05-08 19:57:47 +0000 (Mon, 08 May 2023)</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'>Docs: Update code examples formatting in `WP_HTML_Tag_Processor` documentation.
Per the [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#description documentation standards], code samples should be created by indenting every line of the code by 4 spaces, with a blank line before and after. This matches the format used by the rest of core.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/55203">[55203]</a>, <a href="https://core.trac.wordpress.org/changeset/55304">[55304]</a>, <a href="https://core.trac.wordpress.org/changeset/55718">[55718]</a>, <a href="https://core.trac.wordpress.org/changeset/55724">[55724]</a>.
Props juanmaguitar, coffee2code, azaozz, costdev, dmsnell, johnbillion, SergeyBiryukov.
Merges <a href="https://core.trac.wordpress.org/changeset/55727">[55727]</a> to the 6.2 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/58028">#58028</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches62srcwpincludesclasswpthemejsonphp">branches/6.2/src/wp-includes/class-wp-theme-json.php</a></li>
<li><a href="#branches62srcwpincludeshtmlapiclasswphtmltagprocessorphp">branches/6.2/src/wp-includes/html-api/class-wp-html-tag-processor.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches62">branches/6.2/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.2
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.2 2023-05-08 19:50:46 UTC (rev 55728)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.2 2023-05-08 19:57:47 UTC (rev 55729)
</ins><a id="branches62"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.2</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:55508,55542,55544-55545,55547,55552,55568,55573-55574,55584,55597-55598,55600-55601,55606,55632,55637,55670,55724
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:55508,55542,55544-55545,55547,55552,55568,55573-55574,55584,55597-55598,55600-55601,55606,55632,55637,55670,55724,55727
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches62srcwpincludesclasswpthemejsonphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.2/src/wp-includes/class-wp-theme-json.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.2/src/wp-includes/class-wp-theme-json.php 2023-05-08 19:50:46 UTC (rev 55728)
+++ branches/6.2/src/wp-includes/class-wp-theme-json.php 2023-05-08 19:57:47 UTC (rev 55729)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,15 +66,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * They are a unkeyed array of values such as:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
- * array(
- * array(
- * 'slug' => 'unique-name-within-the-set',
- * 'name' => 'Name for the UI',
- * <value_key> => 'value'
- * ),
- * )
- * ```
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * array(
+ * array(
+ * 'slug' => 'unique-name-within-the-set',
+ * 'name' => 'Name for the UI',
+ * <value_key> => 'value'
+ * ),
+ * )
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This contains the necessary metadata to process them:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2531,19 +2529,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * For metadata values that can either be booleans or paths to booleans, gets the value.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
- * $data = array(
- * 'color' => array(
- * 'defaultPalette' => true
- * )
- * );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * $data = array(
+ * 'color' => array(
+ * 'defaultPalette' => true
+ * )
+ * );
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * static::get_metadata_boolean( $data, false );
- * // => false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * static::get_metadata_boolean( $data, false );
+ * // => false
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * static::get_metadata_boolean( $data, array( 'color', 'defaultPalette' ) );
- * // => true
- * ```
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * static::get_metadata_boolean( $data, array( 'color', 'defaultPalette' ) );
+ * // => true
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="branches62srcwpincludeshtmlapiclasswphtmltagprocessorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.2/src/wp-includes/html-api/class-wp-html-tag-processor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.2/src/wp-includes/html-api/class-wp-html-tag-processor.php 2023-05-08 19:50:46 UTC (rev 55728)
+++ branches/6.2/src/wp-includes/html-api/class-wp-html-tag-processor.php 2023-05-08 19:57:47 UTC (rev 55729)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,12 +38,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * 3. Request changes to the attributes in those tag(s).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * $tags = new WP_HTML_Tag_Processor( $html );
</span><span class="cx" style="display: block; padding: 0 10px"> * if ( $tags->next_tag( 'option' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> * $tags->set_attribute( 'selected', true );
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * ### Finding tags
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,9 +53,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * regardless of what kind it is.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If you want to _find whatever the next tag is_:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * $tags->next_tag();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * | Goal | Query |
</span><span class="cx" style="display: block; padding: 0 10px"> * |-----------------------------------------------------------|---------------------------------------------------------------------------------|
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,7 +85,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * provided by the processor or external state or variables.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * // Paint up to the first five DIV or SPAN tags marked with the "jazzy" style.
</span><span class="cx" style="display: block; padding: 0 10px"> * $remaining_count = 5;
</span><span class="cx" style="display: block; padding: 0 10px"> * while ( $remaining_count > 0 && $tags->next_tag() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,7 +97,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * $remaining_count--;
</span><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">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * `get_attribute()` will return `null` if the attribute wasn't present
</span><span class="cx" style="display: block; padding: 0 10px"> * on the tag when it was called. It may return `""` (the empty string)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -116,12 +113,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * nothing and move on to the next opening tag.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * if ( $tags->next_tag( array( 'class' => 'wp-group-block' ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> * $tags->set_attribute( 'title', 'This groups the contained content.' );
</span><span class="cx" style="display: block; padding: 0 10px"> * $tags->remove_attribute( 'data-test-id' );
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If `set_attribute()` is called for an existing attribute it will
</span><span class="cx" style="display: block; padding: 0 10px"> * overwrite the existing value. Similarly, calling `remove_attribute()`
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,7 +137,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * entire `class` attribute will be removed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * // from `<span>Yippee!</span>`
</span><span class="cx" style="display: block; padding: 0 10px"> * // to `<span class="is-active">Yippee!</span>`
</span><span class="cx" style="display: block; padding: 0 10px"> * $tags->add_class( 'is-active' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,7 +161,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * // from `<input type="text" length="24">`
</span><span class="cx" style="display: block; padding: 0 10px"> * // to `<input type="text" length="24">
</span><span class="cx" style="display: block; padding: 0 10px"> * $tags->remove_class( 'rugby' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * When class changes are enqueued but a direct change to `class` is made via
</span><span class="cx" style="display: block; padding: 0 10px"> * `set_attribute` then the changes to `set_attribute` (or `remove_attribute`)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -184,7 +179,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * and so on. It's fine from a performance standpoint to create a
</span><span class="cx" style="display: block; padding: 0 10px"> * bookmark and update it frequently, such as within a loop.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><span class="cx" style="display: block; padding: 0 10px"> * $total_todos = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> * while ( $p->next_tag( array( 'tag_name' => 'UL', 'class_name' => 'todo' ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->set_bookmark( 'list-start' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,7 +197,6 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * ## Design and limitations
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -335,12 +328,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Byte offset in input document where current tag name starts.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
- * <div id="test">...
- * 01234
- * - tag name starts at 1
- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * <div id="test">...
+ * 01234
+ * - tag name starts at 1
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var int|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -350,12 +342,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Byte length of current tag name.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
- * <div id="test">...
- * 01234
- * --- tag name length is 3
- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * <div id="test">...
+ * 01234
+ * --- tag name length is 3
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var int|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -365,13 +356,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Byte offset in input document where current tag token ends.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
- * <div id="test">...
- * 0 1 |
- * 01234567890123456
- * --- tag name ends at 14
- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * <div id="test">...
+ * 0 1 |
+ * 01234567890123456
+ * --- tag name ends at 14
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var int|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -388,17 +378,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Lazily-built index of attributes found within an HTML tag, keyed by the attribute name.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
- * // supposing the parser is working through this content
- * // and stops after recognizing the `id` attribute
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * // Supposing the parser is working through this content
+ * // and stops after recognizing the `id` attribute.
</ins><span class="cx" style="display: block; padding: 0 10px"> * // <div id="test-4" class=outline title="data:text/plain;base64=asdk3nk1j3fo8">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * // ^ parsing will continue from this point
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * // ^ parsing will continue from this point.
</ins><span class="cx" style="display: block; padding: 0 10px"> * $this->attributes = array(
</span><span class="cx" style="display: block; padding: 0 10px"> * 'id' => new WP_HTML_Attribute_Match( 'id', null, 6, 17 )
</span><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">- * // when picking up parsing again, or when asking to find the
- * // `class` attribute we will continue and add to this array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * // When picking up parsing again, or when asking to find the
+ * // `class` attribute we will continue and add to this array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * $this->attributes = array(
</span><span class="cx" style="display: block; padding: 0 10px"> * 'id' => new WP_HTML_Attribute_Match( 'id', null, 6, 17 ),
</span><span class="cx" style="display: block; padding: 0 10px"> * 'class' => new WP_HTML_Attribute_Match( 'class', 'outline', 18, 32 )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -406,7 +396,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * // Note that only the `class` attribute value is stored in the index.
</span><span class="cx" style="display: block; padding: 0 10px"> * // That's because it is the only value used by this class at the moment.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var WP_HTML_Attribute_Token[]
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -425,14 +414,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * into a single `set_attribute( 'class', $changes )` call.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * // Add the `wp-block-group` class, remove the `wp-group` class.
</span><span class="cx" style="display: block; padding: 0 10px"> * $classname_updates = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * // Indexed by a comparable class name
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * // Indexed by a comparable class name.
</ins><span class="cx" style="display: block; padding: 0 10px"> * 'wp-block-group' => WP_HTML_Tag_Processor::ADD_CLASS,
</span><span class="cx" style="display: block; padding: 0 10px"> * 'wp-group' => WP_HTML_Tag_Processor::REMOVE_CLASS
</span><span class="cx" style="display: block; padding: 0 10px"> * );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var bool[]
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -479,7 +467,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * copies when applying many updates to a single document.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * // Replace an attribute stored with a new value, indices
</span><span class="cx" style="display: block; padding: 0 10px"> * // sourced from the lazily-parsed HTML recognizer.
</span><span class="cx" style="display: block; padding: 0 10px"> * $start = $attributes['src']->start;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -490,7 +478,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * $lexical_updates = array(
</span><span class="cx" style="display: block; padding: 0 10px"> * WP_HTML_Text_Replacement( 14, 28, 'https://my-site.my-domain/wp-content/uploads/2014/08/kittens.jpg' )
</span><span class="cx" style="display: block; padding: 0 10px"> * );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var WP_HTML_Text_Replacement[]
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -608,7 +595,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Release bookmarks when they are no longer needed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * <main><h2>Surprising fact you may not know!</h2></main>
</span><span class="cx" style="display: block; padding: 0 10px"> * ^ ^
</span><span class="cx" style="display: block; padding: 0 10px"> * \-|-- this `H2` opener bookmark tracks the token
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -616,7 +603,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * <main class="clickbait"><h2>Surprising fact you may no…
</span><span class="cx" style="display: block; padding: 0 10px"> * ^ ^
</span><span class="cx" style="display: block; padding: 0 10px"> * \-|-- it shifts with edits
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Bookmarks provide the ability to seek to a previously-scanned
</span><span class="cx" style="display: block; padding: 0 10px"> * place in the HTML document. This avoids the need to re-scan
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -623,7 +609,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the entire document.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * <ul><li>One</li><li>Two</li><li>Three</li></ul>
</span><span class="cx" style="display: block; padding: 0 10px"> * ^^^^
</span><span class="cx" style="display: block; padding: 0 10px"> * want to note this last item
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -650,7 +636,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->set_bookmark( 'last-li' );
</span><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">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Bookmarks intentionally hide the internal string offsets
</span><span class="cx" style="display: block; padding: 0 10px"> * to which they refer. They are maintained internally as
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -727,7 +712,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see https://html.spec.whatwg.org/multipage/parsing.html#rcdata-state
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $tag_name – the lowercase tag name which will close the RCDATA region.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $tag_name The lowercase tag name which will close the RCDATA region.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether an end to the RCDATA region was found before the end of the document.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private function skip_rcdata( $tag_name ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1615,10 +1600,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * or trailing whitespace, and that the casing follows the name given in `set_attribute`.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * $p->set_attribute( 'data-TEST-id', 'update' );
</span><span class="cx" style="display: block; padding: 0 10px"> * 'update' === $p->get_enqueued_attribute_value( 'data-test-id' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Detect this difference based on the absence of the `=`, which _must_ exist in any
</span><span class="cx" style="display: block; padding: 0 10px"> * attribute containing a value, e.g. `<input type="text" enabled />`.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1649,7 +1633,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns the value of a requested attribute from a matched tag opener if that attribute exists.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * $p = new WP_HTML_Tag_Processor( '<div enabled class="test" data-test-id="14">Test</div>' );
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->next_tag( array( 'class_name' => 'test' ) ) === true;
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->get_attribute( 'data-test-id' ) === '14';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1658,7 +1642,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->next_tag() === false;
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->get_attribute( 'class' ) === null;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1730,7 +1713,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * - HTML 5 spec
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * $p = new WP_HTML_Tag_Processor( '<div data-ENABLED class="test" DATA-test-id="14">Test</div>' );
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->next_tag( array( 'class_name' => 'test' ) ) === true;
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->get_attribute_names_with_prefix( 'data-' ) === array( 'data-enabled', 'data-test-id' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1737,7 +1720,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->next_tag() === false;
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->get_attribute_names_with_prefix( 'data-' ) === null;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1766,7 +1748,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns the uppercase name of the matched tag.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * $p = new WP_HTML_Tag_Processor( '<div class="test">Test</div>' );
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->next_tag() === true;
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->get_tag() === 'DIV';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1773,7 +1755,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->next_tag() === false;
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->get_tag() === null;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1793,7 +1774,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Indicates if the current tag token is a tag closer.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * $p = new WP_HTML_Tag_Processor( '<div></div>' );
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->next_tag( array( 'tag_name' => 'div', 'tag_closers' => 'visit' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->is_tag_closer() === false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1800,7 +1781,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->next_tag( array( 'tag_name' => 'div', 'tag_closers' => 'visit' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> * $p->is_tag_closer() === true;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * ```
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1906,12 +1886,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Update an existing attribute.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example – set attribute id to "new" in <div id="initial_id" />:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * <div id="initial_id"/>
- * ^-------------^
- * start end
- * replacement: `id="new"`
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Result: <div id="new"/>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * <div id="initial_id"/>
+ * ^-------------^
+ * start end
+ * replacement: `id="new"`
+ *
+ * Result: <div id="new"/>
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $existing_attribute = $this->attributes[ $comparable_name ];
</span><span class="cx" style="display: block; padding: 0 10px"> $this->lexical_updates[ $comparable_name ] = new WP_HTML_Text_Replacement(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1924,12 +1905,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Create a new attribute at the tag's name end.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example – add attribute id="new" to <div />:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * <div/>
- * ^
- * start and end
- * replacement: ` id="new"`
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Result: <div id="new"/>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * <div/>
+ * ^
+ * start and end
+ * replacement: ` id="new"`
+ *
+ * Result: <div id="new"/>
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $this->lexical_updates[ $comparable_name ] = new WP_HTML_Text_Replacement(
</span><span class="cx" style="display: block; padding: 0 10px"> $this->tag_name_starts_at + $this->tag_name_length,
</span></span></pre>
</div>
</div>
</body>
</html>