Changeset 57056 for trunk/src/wp-includes/kses.php

Timestamp:

11/03/2023 03:31:51 PM (13 months ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Remove unnecessary ignore annotation in wp_kses_hair_parse().

It is perfectly possible to write a commented regex with layout for readability by using the x modifier.

As per the manual:

x (PCRE_EXTENDED)

If this modifier is set, whitespace data characters in the pattern are totally ignored except when escaped or inside a character class, and characters between an unescaped # outside a character class and the next newline character, inclusive, are also ignored. This is equivalent to Perl's /x modifier, and makes it possible to include commentary inside complicated patterns.

Note, however, that this applies only to data characters. Whitespace characters may never appear within special character sequences in a pattern, for example within the sequence (?( which introduces a conditional subpattern.

Reference: ​PHP Manual: Pattern Modifiers.

This commit rewrites these two regexes to use the x modifier and gets rid of the unnecessary phpcs:disable comments.

The tests in the tests/phpunit/tests/db/dbDelta.php file cover this change.

Follow-up to [42249].

Props jrf.
See #59650.

File:

• trunk/src/wp-includes/kses.php (modified) (1 diff)

trunk/src/wp-includes/kses.php

@@ -1537 +1537 @@
     }
 
-    // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
     $regex =
-        '(?:'
-        .     '[_a-zA-Z][-_a-zA-Z0-9:.]*' // Attribute name.
-        . '|'
-        .     '\[\[?[^\[\]]+\]\]?'        // Shortcode in the name position implies unfiltered_html.
-        . ')'
-        . '(?:'               // Attribute value.
-        .     '\s*=\s*'       // All values begin with '='.
-        .     '(?:'
-        .         '"[^"]*"'   // Double-quoted.
-        .     '|'
-        .         "'[^']*'"   // Single-quoted.
-        .     '|'
-        .         '[^\s"\']+' // Non-quoted.
-        .         '(?:\s|$)'  // Must have a space.
-        .     ')'
-        . '|'
-        .     '(?:\s|$)'      // If attribute has no value, space is required.
-        . ')'
-        . '\s*';              // Trailing space is optional except as mentioned above.
-    // phpcs:enable
+        '(?:
+                [_a-zA-Z][-_a-zA-Z0-9:.]* # Attribute name.
+            |
+                \[\[?[^\[\]]+\]\]?        # Shortcode in the name position implies unfiltered_html.
+        )
+        (?:                               # Attribute value.
+            \s*=\s*                       # All values begin with "=".
+            (?:
+                "[^"]*"                   # Double-quoted.
+            |
+                \'[^\']*\'                # Single-quoted.
+            |
+                [^\s"\']+                 # Non-quoted.
+                (?:\s|$)                  # Must have a space.
+            )
+        |
+            (?:\s|$)                      # If attribute has no value, space is required.
+        )
+        \s*                               # Trailing space is optional except as mentioned above.
+        ';
 
     /*
      * Although it is possible to reduce this procedure to a single regexp,
      * we must run that regexp twice to get exactly the expected result.
+     *
+     * Note: do NOT remove the `x` modifiers as they are essential for the above regex!
      */
 
-    $validation = "%^($regex)+$%";
-    $extraction = "%$regex%";
+    $validation = "%^($regex)+$%x";
+    $extraction = "%$regex%x";
 
     if ( 1 === preg_match( $validation, $attr ) ) {