<!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>[29748] trunk: `wptexturize()` improvements:</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 { 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/29748">29748</a></dd>
<dt>Author</dt> <dd>wonderboymusic</dd>
<dt>Date</dt> <dd>2014-09-17 15:13:24 +0000 (Wed, 17 Sep 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>`wptexturize()` improvements:
* Expand the `wptexturize()` RegEx to include the list of registered shortcodes.
* Avoid backtracking after `[` chars by not filtering params in registered shortcodes. This will cause escaped shortcodes and their params to become texturized if not registered.
* Registered shortcode params will never be texturized, even when escaped.
* Move all tests involving unregistered shortcodes to a new and improved unit.
* Update one test involving HTML within shortcode params.
Props miqrogroove.
See <a href="http://core.trac.wordpress.org/ticket/29557">#29557</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunksrcwpincludesshortcodesphp">trunk/src/wp-includes/shortcodes.php</a></li>
<li><a href="#trunktestsphpunittestsformattingWPTexturizephp">trunk/tests/phpunit/tests/formatting/WPTexturize.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesformattingphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/formatting.php (29747 => 29748)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/formatting.php 2014-09-15 18:05:06 UTC (rev 29747)
+++ trunk/src/wp-includes/formatting.php 2014-09-17 15:13:24 UTC (rev 29748)
</span><span class="lines">@@ -28,7 +28,7 @@
</span><span class="cx"> * @return string The string replaced with html entities
</span><span class="cx"> */
</span><span class="cx"> function wptexturize($text, $reset = false) {
</span><del>- global $wp_cockneyreplace;
</del><ins>+ global $wp_cockneyreplace, $shortcode_tags;
</ins><span class="cx"> static $static_characters, $static_replacements, $dynamic_characters, $dynamic_replacements,
</span><span class="cx"> $default_no_texturize_tags, $default_no_texturize_shortcodes, $run_texturize = true;
</span><span class="cx">
</span><span class="lines">@@ -205,6 +205,10 @@
</span><span class="cx">
</span><span class="cx"> // Look for shortcodes and HTML elements.
</span><span class="cx">
</span><ins>+ $tagnames = array_keys( $shortcode_tags );
+ $tagregexp = join( '|', array_map( 'preg_quote', $tagnames ) );
+ $tagregexp = "(?:$tagregexp)(?![\\w-])"; // Excerpt of get_shortcode_regex().
+
</ins><span class="cx"> $regex = '/(' // Capture the entire match.
</span><span class="cx"> . '<' // Find start of element.
</span><span class="cx"> . '(?(?=!--)' // Is this a comment?
</span><span class="lines">@@ -215,11 +219,9 @@
</span><span class="cx"> . '|'
</span><span class="cx"> . '\[' // Find start of shortcode.
</span><span class="cx"> . '\[?' // Shortcodes may begin with [[
</span><del>- . '(?:'
- . '[^\[\]<>]' // Shortcodes do not contain other shortcodes.
- . '|'
- . '<[^>]+>' // HTML elements permitted. Prevents matching ] before >.
- . ')++'
</del><ins>+ . '\/?' // Closing slash may precede name.
+ . $tagregexp // Only match registered shortcodes, because performance.
+ . '[^\[\]]*' // Shortcodes do not contain other shortcodes.
</ins><span class="cx"> . '\]' // Find end of shortcode.
</span><span class="cx"> . '\]?' // Shortcodes may end with ]]
</span><span class="cx"> . ')/s';
</span><span class="lines">@@ -241,19 +243,19 @@
</span><span class="cx">
</span><span class="cx"> continue;
</span><span class="cx">
</span><del>- } elseif ( '[' === $first && 1 === preg_match( '/^\[(?:[^\[\]<>]|<[^>]+>)++\]$/', $curl ) ) {
</del><ins>+ } elseif ( '[' === $first && 1 === preg_match( '/^\[\[?\/?' . $tagregexp . '[^\[\]]*\]\]?$/', $curl ) ) {
</ins><span class="cx"> // This is a shortcode delimiter.
</span><span class="cx">
</span><del>- _wptexturize_pushpop_element( $curl, $no_texturize_shortcodes_stack, $no_texturize_shortcodes );
</del><ins>+ if ( '[[' !== substr( $curl, 0, 2 ) && ']]' !== substr( $curl, -2 ) ) {
+ // Looks like a normal shortcode.
+ _wptexturize_pushpop_element( $curl, $no_texturize_shortcodes_stack, $no_texturize_shortcodes );
+ } else {
+ // Looks like an escaped shortcode.
+ // Do not texturize.
+ // Do not push to the shortcodes stack.
+ continue;
+ }
</ins><span class="cx">
</span><del>- } elseif ( '[' === $first && 1 === preg_match( '/^\[\[?(?:[^\[\]<>]|<[^>]+>)++\]\]?$/', $curl ) ) {
- // This is an escaped shortcode delimiter.
-
- // Do not texturize.
- // Do not push to the shortcodes stack.
-
- continue;
-
</del><span class="cx"> } elseif ( empty( $no_texturize_shortcodes_stack ) && empty( $no_texturize_tags_stack ) ) {
</span><span class="cx"> // This is neither a delimiter, nor is this content inside of no_texturize pairs. Do texturize.
</span><span class="cx">
</span><span class="lines">@@ -313,7 +315,7 @@
</span><span class="cx">
</span><span class="cx"> // Parse out the tag name.
</span><span class="cx"> $space = strpos( $text, ' ' );
</span><del>- if ( FALSE === $space ) {
</del><ins>+ if ( false === $space ) {
</ins><span class="cx"> $space = -1;
</span><span class="cx"> } else {
</span><span class="cx"> $space -= $name_offset;
</span></span></pre></div>
<a id="trunksrcwpincludesshortcodesphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/shortcodes.php (29747 => 29748)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/shortcodes.php 2014-09-15 18:05:06 UTC (rev 29747)
+++ trunk/src/wp-includes/shortcodes.php 2014-09-17 15:13:24 UTC (rev 29748)
</span><span class="lines">@@ -231,7 +231,7 @@
</span><span class="cx"> $tagregexp = join( '|', array_map('preg_quote', $tagnames) );
</span><span class="cx">
</span><span class="cx"> // WARNING! Do not change this regex without changing do_shortcode_tag() and strip_shortcode_tag()
</span><del>- // Also, see shortcode_unautop() and shortcode.js.
</del><ins>+ // Also, see shortcode_unautop() and shortcode.js and wptexturize().
</ins><span class="cx"> return
</span><span class="cx"> '\\[' // Opening bracket
</span><span class="cx"> . '(\\[?)' // 1: Optional second opening bracket for escaping shortcodes: [[tag]]
</span></span></pre></div>
<a id="trunktestsphpunittestsformattingWPTexturizephp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/formatting/WPTexturize.php (29747 => 29748)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/formatting/WPTexturize.php 2014-09-15 18:05:06 UTC (rev 29747)
+++ trunk/tests/phpunit/tests/formatting/WPTexturize.php 2014-09-17 15:13:24 UTC (rev 29748)
</span><span class="lines">@@ -11,7 +11,6 @@
</span><span class="cx">
</span><span class="cx"> function test_disable() {
</span><span class="cx"> $this->assertEquals('<pre>---</pre>', wptexturize('<pre>---</pre>'));
</span><del>- $this->assertEquals('[a]a–b[code]---[/code]a–b[/a]', wptexturize('[a]a--b[code]---[/code]a--b[/a]'));
</del><span class="cx"> $this->assertEquals('<pre><code></code>--</pre>', wptexturize('<pre><code></code>--</pre>'));
</span><span class="cx">
</span><span class="cx"> $this->assertEquals( '<code>---</code>', wptexturize( '<code>---</code>' ) );
</span><span class="lines">@@ -1209,30 +1208,22 @@
</span><span class="cx"> '[gallery ...]]',
</span><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '[/...]', // This would actually be ignored by the shortcode system. The decision to not texturize it is intentional, if not correct.
- '[/...]',
</del><ins>+ '[/gallery ...]', // This would actually be ignored by the shortcode system. The decision to not texturize it is intentional, if not correct.
+ '[/gallery ...]',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><span class="cx"> '[...]...[/...]', // These are potentially usable shortcodes.
</span><del>- '[...]…[/...]',
</del><ins>+ '[…]…[/…]',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '[[...]]...[[/...]]', // Shortcode parsing will ignore the inner ]...[ part and treat this as a single escaped shortcode.
- '[[...]]…[[/...]]',
</del><ins>+ '[[gallery]]...[[/gallery]]', // Shortcode parsing will ignore the inner ]...[ part and treat this as a single escaped shortcode.
+ '[[gallery]]…[[/gallery]]',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '[[[...]]]...[[[/...]]]', // Again, shortcode parsing matches, but only the [[...] and [/...]] parts.
- '[[[...]]]…[[[/...]]]',
</del><ins>+ '[[[gallery]]]...[[[/gallery]]]', // Again, shortcode parsing matches, but only the [[gallery] and [/gallery]] parts.
+ '[[[gallery]]]…[[[/gallery]]]',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '[[code]...[/code]...', // These are potentially usable shortcodes. Unfortunately, the meaning of [[code] is ambiguous unless we run the entire shortcode regexp.
- '[[code]…[/code]…',
- ),
- array(
- '[code]...[/code]]...', // These are potentially usable shortcodes. Unfortunately, the meaning of [/code]] is ambiguous unless we run the entire shortcode regexp.
- '[code]...[/code]]...', // This test would not pass in 3.9 because the extra brace was always ignored by texturize.
- ),
- array(
</del><span class="cx"> '[gal>ery ...]',
</span><span class="cx"> '[gal>ery …]',
</span><span class="cx"> ),
</span><span class="lines">@@ -1345,8 +1336,8 @@
</span><span class="cx"> '[ but also catches the <b>styled “[quote]” here</b> ]',
</span><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '[Let\'s get crazy<input>[plugin code="<a href=\'?a[]=100\'>hello</a>"]</input>world]',
- '[Let’s get crazy<input>[plugin code="<a href=\'?a[]=100\'>hello</a>"]</input>world]',
</del><ins>+ '[Let\'s get crazy<input>[caption code="<a href=\'?a[]=100\'>hello</a>"]</input>world]', // caption shortcode is invalid here because it contains [] chars.
+ '[Let’s get crazy<input>[caption code=”<a href=\'?a[]=100\'>hello</a>“]</input>world]',
</ins><span class="cx"> ),
</span><span class="cx"> );
</span><span class="cx"> }
</span><span class="lines">@@ -1698,33 +1689,86 @@
</span><span class="cx"> '<code>hello</span>---</span>',
</span><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '<span>hello[/code]---</span>',
- '<span>hello[/code]—</span>',
</del><ins>+ '<span><code>hello</code>---</span>',
+ '<span><code>hello</code>—</span>',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '[/code]hello<span>---</span>',
- '[/code]hello<span>—</span>',
</del><ins>+ '<code>hello</code>world<span>---</span>',
+ '<code>hello</code>world<span>—</span>',
</ins><span class="cx"> ),
</span><ins>+ );
+ }
+
+ /**
+ * Test disabling shortcode texturization.
+ *
+ * @ticket 29557
+ * @dataProvider data_unregistered_shortcodes
+ */
+ function test_unregistered_shortcodes( $input, $output ) {
+ add_filter( 'no_texturize_shortcodes', array( $this, 'filter_shortcodes' ), 10, 1 );
+
+ $output = $this->assertEquals( $output, wptexturize( $input ) );
+
+ remove_filter( 'no_texturize_shortcodes', array( $this, 'filter_shortcodes' ), 10, 1 );
+ return $output;
+ }
+
+ function filter_shortcodes( $disabled ) {
+ $disabled[] = 'audio';
+ return $disabled;
+ }
+
+ function data_unregistered_shortcodes() {
+ return array(
</ins><span class="cx"> array(
</span><del>- '[code]hello[/code]---</span>',
- '[code]hello[/code]—</span>',
</del><ins>+ '[a]a--b[audio]---[/audio]a--b[/a]',
+ '[a]a–b[audio]---[/audio]a–b[/a]',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '<span>hello</span>---[code]',
- '<span>hello</span>—[code]',
</del><ins>+ '[code ...]...[/code]', // code is not a registered shortcode.
+ '[code …]…[/code]',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '<span>hello[code]---</span>',
- '<span>hello[code]---</span>',
</del><ins>+ '[hello ...]...[/hello]', // hello is not a registered shortcode.
+ '[hello …]…[/hello]',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '[code]hello<span>---</span>',
- '[code]hello<span>---</span>',
</del><ins>+ '[[audio]...[/audio]...', // These are potentially usable shortcodes. Unfortunately, the meaning of [[audio] is ambiguous unless we run the entire shortcode regexp.
+ '[[audio]…[/audio]…',
</ins><span class="cx"> ),
</span><span class="cx"> array(
</span><del>- '[code]hello</span>---</span>',
- '[code]hello</span>---</span>',
</del><ins>+ '[audio]...[/audio]]...', // These are potentially usable shortcodes. Unfortunately, the meaning of [/audio]] is ambiguous unless we run the entire shortcode regexp.
+ '[audio]...[/audio]]...', // This test would not pass in 3.9 because the extra brace was always ignored by texturize.
</ins><span class="cx"> ),
</span><ins>+ array(
+ '<span>hello[/audio]---</span>',
+ '<span>hello[/audio]—</span>',
+ ),
+ array(
+ '[/audio]hello<span>---</span>',
+ '[/audio]hello<span>—</span>',
+ ),
+ array(
+ '[audio]hello[/audio]---</span>',
+ '[audio]hello[/audio]—</span>',
+ ),
+ array(
+ '<span>hello</span>---[audio]',
+ '<span>hello</span>—[audio]',
+ ),
+ array(
+ '<span>hello[audio]---</span>',
+ '<span>hello[audio]---</span>',
+ ),
+ array(
+ '[audio]hello<span>---</span>',
+ '[audio]hello<span>---</span>',
+ ),
+ array(
+ '[audio]hello</span>---</span>',
+ '[audio]hello</span>---</span>',
+ ),
</ins><span class="cx"> );
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>