Correct way to add comments to a Regular Expression in PHP

Question

I'm trying to add comments to make a regexp clearer

// Strip any URLs (such as embeds) taken from http://stackoverflow.com/questions/6427530/regular-expression-pattern-to-match-url-with-or-without-http-www
$pattern =
    '(                               # First capturing group
            (http|https)             # Second capturing grout,matches wither http or https
        \:\/\/)?                     # End of first capturing group, matches :// exactly
        [                            # Match any char in the following list. the + after the closing bracke means greedy
            a-z                      # Any char between a and z
            A-Z                      # Any char between A and Z
            0-9                      # Any char between 0 and 9
            \.\/\?\:@\-              # ./?:@- literally ( any one of them )
            _=#                      # _=# any of these thre chars
        ]+                           # end of list
        \.                           # matches .
        (                            # third caturing group
            [                        # start of list
                a-z                  # Any char between a and z
                A-Z                  # Any char between A and Z
                0-9                  # Any char between 0 and 9
                \.\/\?\:@\-          # ./?:@- literally ( any one of them )
                _=#                  # _=# any of these thre chars
            ]                        # end of list
        )*                           # end of capturing group with greedy modifier';
$excerpt = preg_replace("/$pattern/x", '', $excerpt );

But i get the warning

Warning: preg_replace(): Unknown modifier '/' in on line 280

How should i comment it?

You would probably have to separate each piece and concatenate them with the `.` operator. — segFault, Jan 03 '16 at 15:47
You can't but comments inside a character class. white-spaces are always significant inside a character class, even with the x modifier. — Casimir et Hippolyte, Jan 03 '16 at 16:24
Is it possible to make comments using x modifier if you are using # as a delimiter? — EJTH, Mar 29 '18 at 15:17

segFault · Accepted Answer · 2016-01-03T16:10:12.567

This may not be the cleanest approach, but you could enclose each section in quotes and concatenate them.

Something like this should work:

$pattern =
    '('.                             // First capturing group
        '(http|https)'.              // Second capturing grout,matches wither http or https
    '\:\/\/)?'.                      // End of first capturing group, matches :// exactly
    ...

Alternatively I found this in PHP docs.

So I imagine that would work too, but you are using the x modifier and that should be working already.

If the PCRE_EXTENDED option is set, an unescaped # character outside a character class introduces a comment that continues up to the next newline character in the pattern.

This indicates all of you comments within a character set [...] are invalid.

Here is a working example for use with the PCRE_EXTENDED modifier:

$pattern = '
    (                              # First capturing group
        (http[s]?)                 # Second capturing grout,matches wither http or https
    \:\/\/)?                       # End of first capturing group, matches :// exactly
    [a-zA-Z0-9\.\/\?\:@\-_=#]+     # [List Comment Here]
    \.                             # matches .
    (                              # third caturing group
        [a-zA-Z0-9\.\/\?\:@\-_=#]  # [List Comment Here]
    )*                             # end of capturing group with greedy modifier
';

As other pointed out you need to remove or escape delimiters in comment — Nicola Peluchetti, Jan 03 '16 at 16:20

score 4 · Answer 2 · answered Jan 03 '16 at 16:18

This was brought up in a comment on the php.net modifiers page.

To quote:

When adding comments with the /x modifier, don't use the pattern delimiter in the comments. It may not be ignored in the comments area.

In your example, one of your comments has the string :// embedded within it. Since PHP seems to not parse regex delimiters by taking into account flags, it sees this as a problem. The same can be seen with the below code:

echo preg_replace('/
a #Com/ment
/x', 'e', 'and');

Demo

You would need to either change your delimiter or escape the delimiter in comments.

score 0 · Answer 3 · answered Feb 20 '22 at 06:08

While it has already been said that the problem in your snippet comes from using the pattern delimiter in your pattern comments, completely refactoring the pattern to implement D.R.Y. practices will make your regex much simpler to read and maintain.

Use a delimiting character that will not be found inside your pattern -- this eliminates avoidable escaping.
((http|https)\:\/\/)? can be simplified to (?:https?://)? and still maintain its optional status in the pattern.
Your alphanumeric character class plus a short list of symbols can be reduced to [\w./?:@=#-]+.

Code:

// strip urls
$pattern = <<<REGEX
~
(?:https?://)?  # optionally, case-insensitively match http or https followed by colon, forwardslash, forwardslash
[\w./?:@=#-]+   # greedily match one or more characters from this list: any letters, any number, underscore, dot, forwardslash, question mark, colon, ampersand, equals, hash, hyphen
\.              # match a dot
[\w./?:@=#-]*   # greedily match zero or more characters from this list: any letters, any number, underscore, dot, forwardslash, question mark, colon, ampersand, equals, hash, hyphen
~ix
REGEX;

$excerpt = preg_replace($pattern, '', $excerpt);

After cleaning up and removing all of the bloat from your pattern, it may actually become attractive to encapsulate all of the inline comments as a comment prior to declaring the pattern because this affords the ability to wrap long lines onto newlines without breaking your pattern.

Correct way to add comments to a Regular Expression in PHP

3 Answers3