<!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>[42249] trunk/src: General: Add inline PHPCS options to leave regex indentation.</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" 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/42249">42249</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/42249","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-11-28 04:23:11 +0000 (Tue, 28 Nov 2017)</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'>General: Add inline PHPCS options to leave regex indentation.
We have a handful of super long regexen that are written over multiple lines, as a collection of strings concatenated together. Each string is indented appropriately for the regex, but PHPCS doesn't recognised this, so defaults to removing the extra whitespace.
Disabling the `Squiz.Strings.ConcatenationSpacing.PaddingFound` rule for these blocks stops the extra whitespace from being removed.
See <a href="https://core.trac.wordpress.org/ticket/41057">#41057</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesupgradephp">trunk/src/wp-admin/includes/upgrade.php</a></li>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunksrcwpincludesksesphp">trunk/src/wp-includes/kses.php</a></li>
<li><a href="#trunksrcwpincludesshortcodesphp">trunk/src/wp-includes/shortcodes.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesupgradephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/upgrade.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/upgrade.php 2017-11-27 03:52:21 UTC (rev 42248)
+++ trunk/src/wp-admin/includes/upgrade.php 2017-11-28 04:23:11 UTC (rev 42249)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2248,6 +2248,7 @@
</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"> // Extract type, name and columns from the definition.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</ins><span class="cx" style="display: block; padding: 0 10px"> preg_match(
</span><span class="cx" style="display: block; padding: 0 10px"> '/^'
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?P<index_type>' // 1) Type of the index.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2271,6 +2272,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $fld,
</span><span class="cx" style="display: block; padding: 0 10px"> $index_matches
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:enable
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Uppercase the index type and normalize space characters.
</span><span class="cx" style="display: block; padding: 0 10px"> $index_type = strtoupper( preg_replace( '/\s+/', ' ', trim( $index_matches['index_type'] ) ) );
</span></span></pre></div>
<a id="trunksrcwpincludesformattingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2017-11-27 03:52:21 UTC (rev 42248)
+++ trunk/src/wp-includes/formatting.php 2017-11-28 04:23:11 UTC (rev 42249)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -617,8 +617,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> static $regex;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $regex ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</ins><span class="cx" style="display: block; padding: 0 10px"> $comments =
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '!' // Start of comment, after the <.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '!' // Start of comment, after the <.
</ins><span class="cx" style="display: block; padding: 0 10px"> . '(?:' // Unroll the loop: Consume everything until --> is found.
</span><span class="cx" style="display: block; padding: 0 10px"> . '-(?!->)' // Dash not followed by end of comment.
</span><span class="cx" style="display: block; padding: 0 10px"> . '[^\-]*+' // Consume non-dashes.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -626,7 +627,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?:-->)?'; // End of comment. If not found, match all input.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $cdata =
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '!\[CDATA\[' // Start of comment, after the <.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '!\[CDATA\[' // Start of comment, after the <.
</ins><span class="cx" style="display: block; padding: 0 10px"> . '[^\]]*+' // Consume non-].
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?:' // Unroll the loop: Consume everything until ]]> is found.
</span><span class="cx" style="display: block; padding: 0 10px"> . '](?!]>)' // One ] not followed by end of comment.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -635,7 +636,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?:]]>)?'; // End of comment. If not found, match all input.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $escaped =
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '(?=' // Is the element escaped?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '(?=' // Is the element escaped?
</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"> . '!\[CDATA\['
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -647,7 +648,7 @@
</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"> $regex =
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '/(' // Capture the entire match.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '/(' // Capture the entire match.
</ins><span class="cx" style="display: block; padding: 0 10px"> . '<' // Find start of element.
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?' // Conditional expression follows.
</span><span class="cx" style="display: block; padding: 0 10px"> . $escaped // Find end of escaped element.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -655,6 +656,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> . '[^>]*>?' // Find end of normal element.
</span><span class="cx" style="display: block; padding: 0 10px"> . ')'
</span><span class="cx" style="display: block; padding: 0 10px"> . ')/';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:enable
</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"> return $regex;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -677,8 +679,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> static $html_regex;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $html_regex ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</ins><span class="cx" style="display: block; padding: 0 10px"> $comment_regex =
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '!' // Start of comment, after the <.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '!' // Start of comment, after the <.
</ins><span class="cx" style="display: block; padding: 0 10px"> . '(?:' // Unroll the loop: Consume everything until --> is found.
</span><span class="cx" style="display: block; padding: 0 10px"> . '-(?!->)' // Dash not followed by end of comment.
</span><span class="cx" style="display: block; padding: 0 10px"> . '[^\-]*+' // Consume non-dashes.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -686,12 +689,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?:-->)?'; // End of comment. If not found, match all input.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $html_regex = // Needs replaced with wp_html_split() per Shortcode API Roadmap.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<' // Find start of element.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<' // Find start of element.
</ins><span class="cx" style="display: block; padding: 0 10px"> . '(?(?=!--)' // Is this a comment?
</span><span class="cx" style="display: block; padding: 0 10px"> . $comment_regex // Find end of comment.
</span><span class="cx" style="display: block; padding: 0 10px"> . '|'
</span><span class="cx" style="display: block; padding: 0 10px"> . '[^>]*>?' // Find end of element. If not found, match all input.
</span><span class="cx" style="display: block; padding: 0 10px"> . ')';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:enable
</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 ( empty( $shortcode_regex ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -717,6 +721,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function _get_wptexturize_shortcode_regex( $tagnames ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $tagregexp = join( '|', array_map( 'preg_quote', $tagnames ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $tagregexp = "(?:$tagregexp)(?=[\\s\\]\\/])"; // Excerpt of get_shortcode_regex().
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</ins><span class="cx" style="display: block; padding: 0 10px"> $regex =
</span><span class="cx" style="display: block; padding: 0 10px"> '\[' // Find start of shortcode.
</span><span class="cx" style="display: block; padding: 0 10px"> . '[\/\[]?' // Shortcodes may begin with [/ or [[
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -728,6 +733,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> . ')*+' // Possessive critical.
</span><span class="cx" style="display: block; padding: 0 10px"> . '\]' // Find end of shortcode.
</span><span class="cx" style="display: block; padding: 0 10px"> . '\]?'; // Shortcodes may end with ]]
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:enable
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $regex;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -817,6 +823,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tagregexp = join( '|', array_map( 'preg_quote', array_keys( $shortcode_tags ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $spaces = wp_spaces_regexp();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</ins><span class="cx" style="display: block; padding: 0 10px"> $pattern =
</span><span class="cx" style="display: block; padding: 0 10px"> '/'
</span><span class="cx" style="display: block; padding: 0 10px"> . '<p>' // Opening paragraph
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -848,6 +855,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?:' . $spaces . ')*+' // optional trailing whitespace
</span><span class="cx" style="display: block; padding: 0 10px"> . '<\\/p>' // closing paragraph
</span><span class="cx" style="display: block; padding: 0 10px"> . '/';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:enable
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return preg_replace( $pattern, '$1', $pee );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesksesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/kses.php 2017-11-27 03:52:21 UTC (rev 42248)
+++ trunk/src/wp-includes/kses.php 2017-11-28 04:23:11 UTC (rev 42249)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1093,6 +1093,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</ins><span class="cx" style="display: block; padding: 0 10px"> $regex =
</span><span class="cx" style="display: block; padding: 0 10px"> '(?:'
</span><span class="cx" style="display: block; padding: 0 10px"> . '[-a-zA-Z:]+' // Attribute name.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1113,6 +1114,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?:\s|$)' // If attribute has no value, space is required.
</span><span class="cx" style="display: block; padding: 0 10px"> . ')'
</span><span class="cx" style="display: block; padding: 0 10px"> . '\s*'; // Trailing space is optional except as mentioned above.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:enable
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Although it is possible to reduce this procedure to a single regexp,
</span><span class="cx" style="display: block; padding: 0 10px"> // we must run that regexp twice to get exactly the expected result.
</span></span></pre></div>
<a id="trunksrcwpincludesshortcodesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/shortcodes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/shortcodes.php 2017-11-27 03:52:21 UTC (rev 42248)
+++ trunk/src/wp-includes/shortcodes.php 2017-11-28 04:23:11 UTC (rev 42249)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -235,8 +235,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // WARNING! Do not change this regex without changing do_shortcode_tag() and strip_shortcode_tag()
</span><span class="cx" style="display: block; padding: 0 10px"> // Also, see shortcode_unautop() and shortcode.js.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</ins><span class="cx" style="display: block; padding: 0 10px"> return
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '\\[' // Opening bracket
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '\\[' // Opening bracket
</ins><span class="cx" style="display: block; padding: 0 10px"> . '(\\[?)' // 1: Optional second opening bracket for escaping shortcodes: [[tag]]
</span><span class="cx" style="display: block; padding: 0 10px"> . "($tagregexp)" // 2: Shortcode name
</span><span class="cx" style="display: block; padding: 0 10px"> . '(?![\\w-])' // Not followed by word character or hyphen
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -264,6 +266,7 @@
</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"> . '(\\]?)'; // 6: Optional second closing brocket for escaping shortcodes: [[tag]]
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // phpcs:enable
</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"> /**
</span></span></pre>
</div>
</div>
</body>
</html>