PCRE
Table of Contents
Functions
- preg_escape() : string
- Escapes all instances of the given PCRE delimiter character in a raw regular expression pattern.
Functions
preg_escape()
Escapes all instances of the given PCRE delimiter character in a raw regular expression pattern.
preg_escape(string $pattern, non-empty-string $delimiter) : string
preg_escape() takes pattern and puts a backslash in front of every unescaped delimiter. This is useful to prepare raw regular expression patterns for use with PHP's PCRE functions.
For example:
preg_escape('foo_bar', '_'); // returns `foo\_bar`
preg_escape('foo\\_bar', '_'); // returns `foo\_bar`
Parameters
- $pattern : string
-
The input pattern.
- $delimiter : non-empty-string
-
The delimiter to be escaped. Must be a single non-alphanumeric, non-backslash, non-whitespace character.
This function doesn't support bracket style delimiters (
(,),{,},[,],<, and>).
Return values
string —The pattern with all instances of delimiter escaped where needed.