Changeset 42249

Timestamp:

11/28/2017 04:23:11 AM (7 years ago)

Author:

pento

Message:

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 #41057.

Location:

trunk/src

Files:

• wp-admin/includes/upgrade.php (modified) (2 diffs)
• wp-includes/formatting.php (modified) (12 diffs)
• wp-includes/kses.php (modified) (2 diffs)
• wp-includes/shortcodes.php (modified) (2 diffs)

trunk/src/wp-admin/includes/upgrade.php

@@ -2249 +2249 @@
 
                     // Extract type, name and columns from the definition.
+                    // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
                     preg_match(
                         '/^'
@@ -2272 +2273 @@
                         $index_matches
                     );
+                    // phpcs:enable
 
                     // Uppercase the index type and normalize space characters.

trunk/src/wp-includes/formatting.php

@@ -618 +618 @@
 
     if ( ! isset( $regex ) ) {
+        // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
         $comments =
-            '!'           // Start of comment, after the <.
+            '!'             // Start of comment, after the <.
             . '(?:'         // Unroll the loop: Consume everything until --> is found.
             .     '-(?!->)' // Dash not followed by end of comment.
@@ -627 +628 @@
 
         $cdata =
-            '!\[CDATA\['  // Start of comment, after the <.
+            '!\[CDATA\['    // Start of comment, after the <.
             . '[^\]]*+'     // Consume non-].
             . '(?:'         // Unroll the loop: Consume everything until ]]> is found.
@@ -636 +637 @@
 
         $escaped =
-            '(?='           // Is the element escaped?
+            '(?='             // Is the element escaped?
             .    '!--'
             . '|'
@@ -648 +649 @@
 
         $regex =
-            '/('              // Capture the entire match.
+            '/('                // Capture the entire match.
             .     '<'           // Find start of element.
             .     '(?'          // Conditional expression follows.
@@ -656 +657 @@
             .     ')'
             . ')/';
+        // phpcs:enable
     }
 
@@ -678 +680 @@
 
     if ( ! isset( $html_regex ) ) {
+        // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
         $comment_regex =
-            '!'           // Start of comment, after the <.
+            '!'             // Start of comment, after the <.
             . '(?:'         // Unroll the loop: Consume everything until --> is found.
             .     '-(?!->)' // Dash not followed by end of comment.
@@ -687 +690 @@
 
         $html_regex =            // Needs replaced with wp_html_split() per Shortcode API Roadmap.
-            '<'                // Find start of element.
+            '<'                  // Find start of element.
             . '(?(?=!--)'        // Is this a comment?
             .     $comment_regex // Find end of comment.
@@ -693 +696 @@
             .     '[^>]*>?'      // Find end of element. If not found, match all input.
             . ')';
+        // phpcs:enable
     }
 
@@ -718 +722 @@
     $tagregexp = join( '|', array_map( 'preg_quote', $tagnames ) );
     $tagregexp = "(?:$tagregexp)(?=[\\s\\]\\/])"; // Excerpt of get_shortcode_regex().
+    // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
     $regex =
         '\['              // Find start of shortcode.
@@ -729 +734 @@
         . '\]'              // Find end of shortcode.
         . '\]?';            // Shortcodes may end with ]]
+    // phpcs:enable
 
     return $regex;
@@ -818 +824 @@
     $spaces = wp_spaces_regexp();
 
+    // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
     $pattern =
         '/'
@@ -849 +856 @@
         . '<\\/p>'                           // closing paragraph
         . '/';
+    // phpcs:enable
 
     return preg_replace( $pattern, '$1', $pee );

trunk/src/wp-includes/kses.php

@@ -1094 +1094 @@
     }
 
+    // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
     $regex =
     '(?:'
@@ -1114 +1115 @@
     . ')'
     . '\s*';              // Trailing space is optional except as mentioned above.
+    // phpcs:enable
 
     // Although it is possible to reduce this procedure to a single regexp,

trunk/src/wp-includes/shortcodes.php

@@ -236 +236 @@
     // WARNING! Do not change this regex without changing do_shortcode_tag() and strip_shortcode_tag()
     // Also, see shortcode_unautop() and shortcode.js.
+
+    // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
     return
-        '\\['                              // Opening bracket
+        '\\['                                // Opening bracket
         . '(\\[?)'                           // 1: Optional second opening bracket for escaping shortcodes: [[tag]]
         . "($tagregexp)"                     // 2: Shortcode name
@@ -265 +267 @@
         . ')'
         . '(\\]?)';                          // 6: Optional second closing brocket for escaping shortcodes: [[tag]]
+    // phpcs:enable
 }