<!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>[43727] branches/5.0: KSES: Allow HTML data-* attributes.</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/43727">43727</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/43727","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-10-15 05:21:04 +0000 (Mon, 15 Oct 2018)</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'>KSES: Allow HTML data-* attributes.
Add global support for HTML attributes prefixed `data-` for authors and contributors, as required by the new editor.
Props azaozz, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/33121">#33121</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpincludesksesphp">branches/5.0/src/wp-includes/kses.php</a></li>
<li><a href="#branches50testsphpunittestsksesphp">branches/5.0/tests/phpunit/tests/kses.php</a></li>
<li><a href="#branches50testsphpunittestsrestapirestattachmentscontrollerphp">branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
<li><a href="#branches50testsphpunittestsrestapirestpostscontrollerphp">branches/5.0/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcwpincludesksesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/kses.php 2018-10-15 02:47:44 UTC (rev 43726)
+++ branches/5.0/src/wp-includes/kses.php 2018-10-15 05:21:04 UTC (rev 43727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -854,6 +854,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Determine whether an attribute is allowed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.3
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.0.0 Add support for `data-*` wildcard attributes.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name The attribute name. Returns empty string when not allowed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $value The attribute value. Returns a filtered value.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -864,12 +865,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool Is the attribute allowed?
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_kses_attr_check( &$name, &$value, &$whole, $vless, $element, $allowed_html ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $allowed_attr = $allowed_html[strtolower( $element )];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowed_attr = $allowed_html[ strtolower( $element ) ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $name_low = strtolower( $name );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $allowed_attr[$name_low] ) || '' == $allowed_attr[$name_low] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $name = $value = $whole = '';
- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Allow `data-*` attributes.
+ *
+ * When specifying `$allowed_html`, the attribute name should be set as
+ * `data-*` (not to be mixed with the HTML 4.0 `data` attribute, see
+ * https://www.w3.org/TR/html40/struct/objects.html#adef-data).
+ *
+ * Note: the attribute name should only contain `A-Za-z0-9_-` chars,
+ * double hyphens `--` are not accepted by WordPress.
+ */
+ if ( strpos( $name_low, 'data-' ) === 0 && ! empty( $allowed_attr['data-*'] ) && preg_match( '/^data(?:-[a-z0-9_]+)+$/', $name_low, $match ) ) {
+ /*
+ * Add the whole attribute name to the allowed attributes and set any restrictions
+ * for the `data-*` attribute values for the current element.
+ */
+ $allowed_attr[ $match[0] ] = $allowed_attr['data-*'];
+ } else {
+ $name = $value = $whole = '';
+ return false;
+ }
</ins><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"> if ( 'style' == $name_low ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -884,7 +904,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $value = $new_value;
</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">- if ( is_array( $allowed_attr[$name_low] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_array( $allowed_attr[ $name_low ] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // there are some checks
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $allowed_attr[$name_low] as $currkey => $currval ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_kses_check_attr_val( $value, $vless, $currkey, $currval ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1808,6 +1828,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Helper function to add global attributes to a tag in the allowed html list.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.0.0 Add support for `data-*` wildcard attributes.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $value An array of attributes.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1820,6 +1841,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'style' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'title' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'role' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'data-*' => true,
</ins><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"> if ( true === $value )
</span></span></pre></div>
<a id="branches50testsphpunittestsksesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/tests/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/kses.php 2018-10-15 02:47:44 UTC (rev 43726)
+++ branches/5.0/tests/phpunit/tests/kses.php 2018-10-15 05:21:04 UTC (rev 43727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -718,4 +718,99 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( "<{$element}>", wp_kses_attr( $element, $attribute, array( 'foo' => false ), array() ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Data attributes are globally accepted.
+ *
+ * @ticket 33121
+ */
+ function test_wp_kses_attr_data_attribute_is_allowed() {
+ $test = '<div data-foo="foo" data-bar="bar" datainvalid="gone" data--invaild="gone" data-also-invaild-="gone" data-two-hyphens="remains">Pens and pencils</div>';
+ $expected = '<div data-foo="foo" data-bar="bar" data-two-hyphens="remains">Pens and pencils</div>';
+
+ $this->assertEquals( $expected, wp_kses_post( $test ) );
+ }
+
+ /**
+ * Ensure wildcard attributes block unprefixed wildcard uses.
+ *
+ * @ticket 33121
+ */
+ function test_wildcard_requires_hyphen_after_prefix() {
+ $allowed_html = array(
+ 'div' => array(
+ 'data-*' => true,
+ 'on-*' => true,
+ ),
+ );
+
+ $string = '<div datamelformed-prefix="gone" data="gone" data-="gone" onclick="alert(1)">Malformed attributes</div>';
+ $expected = '<div>Malformed attributes</div>';
+
+ $actual = wp_kses( $string, $allowed_html );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Ensure wildcard allows two hyphen.
+ *
+ * @ticket 33121
+ */
+ function test_wildcard_allows_two_hyphens() {
+ $allowed_html = array(
+ 'div' => array(
+ 'data-*' => true,
+ ),
+ );
+
+ $string = '<div data-wp-id="pens-and-pencils">Well formed attribute</div>';
+ $expected = '<div data-wp-id="pens-and-pencils">Well formed attribute</div>';
+
+ $actual = wp_kses( $string, $allowed_html );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Ensure wildcard attributes only support valid prefixes.
+ *
+ * @dataProvider data_wildcard_attribute_prefixes
+ *
+ * @ticket 33121
+ */
+ function test_wildcard_attribute_prefixes( $wildcard_attribute, $expected ) {
+ $allowed_html = array(
+ 'div' => array(
+ $wildcard_attribute => true,
+ ),
+ );
+
+ $name = str_replace( '*', strtolower( __FUNCTION__ ), $wildcard_attribute );
+ $value = __FUNCTION__;
+ $whole = "{$name}=\"{$value}\"";
+
+ $actual = wp_kses_attr_check( $name, $value, $whole, 'n', 'div', $allowed_html );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * @return array Array of arguments for wildcard testing
+ * [0] The prefix being tested.
+ * [1] The outcome of `wp_kses_attr_check` for the prefix.
+ */
+ function data_wildcard_attribute_prefixes() {
+ return array(
+ // Ends correctly
+ array( 'data-*', true ),
+
+ // Does not end with trialing `-`.
+ array( 'data*', false ),
+
+ // Multiple wildcards.
+ array( 'd*ta-*', false ),
+ array( 'data**', false ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="branches50testsphpunittestsrestapirestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2018-10-15 02:47:44 UTC (rev 43726)
+++ branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2018-10-15 05:21:04 UTC (rev 43727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -928,9 +928,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> // Raw values.
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title' => '<a href="#" target="_blank" data-unfiltered=true>link</a>',
- 'description' => '<a href="#" target="_blank" data-unfiltered=true>link</a>',
- 'caption' => '<a href="#" target="_blank" data-unfiltered=true>link</a>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'title' => '<a href="#" target="_blank" unfiltered=true>link</a>',
+ 'description' => '<a href="#" target="_blank" unfiltered=true>link</a>',
+ 'caption' => '<a href="#" target="_blank" unfiltered=true>link</a>',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> // Expected returned values.
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre></div>
<a id="branches50testsphpunittestsrestapirestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/tests/rest-api/rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/rest-api/rest-posts-controller.php 2018-10-15 02:47:44 UTC (rev 43726)
+++ branches/5.0/tests/phpunit/tests/rest-api/rest-posts-controller.php 2018-10-15 05:21:04 UTC (rev 43727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2913,9 +2913,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> // Raw values.
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title' => '<a href="#" target="_blank" data-unfiltered=true>link</a>',
- 'content' => '<a href="#" target="_blank" data-unfiltered=true>link</a>',
- 'excerpt' => '<a href="#" target="_blank" data-unfiltered=true>link</a>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'title' => '<a href="#" target="_blank" unfiltered=true>link</a>',
+ 'content' => '<a href="#" target="_blank" unfiltered=true>link</a>',
+ 'excerpt' => '<a href="#" target="_blank" unfiltered=true>link</a>',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> // Expected returned values.
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre>
</div>
</div>
</body>
</html>