preg_quote
(PHP 4, PHP 5, PHP 7)
preg_quote — Экранирует символы в регулярных выражениях
Описание
$str
[, string $delimiter = NULL
] )
Функция preg_quote() принимает строку str
и добавляет обратный слеш перед каждым служебным символом.
Это бывает полезно, если в составлении шаблона участвуют строковые переменные,
значение которых в процессе работы скрипта может меняться.
В регулярных выражениях служебными считаются следующие символы: . \ + * ? [ ^ ] $ ( ) { } = ! < > | : -
Список параметров
-
str -
Входная строка.
-
delimiter -
В случае если указан необязательный параметр
delimiter, он будет также экранироваться. Это удобно для экранирования разделителя, который используется в PCRE функциях. Наиболее распространенным разделителем является символ '/'.
Возвращаемые значения
Возвращает экранированную строку.
Список изменений
| Версия | Описание |
|---|---|
| 5.3.0 | Символ - теперь экранируется |
Примеры
Пример #1 preg_quote() пример
<?php
$keywords = '$40 за g3/400';
$keywords = preg_quote($keywords, '/');
echo $keywords; // возвращает \$40 за g3\/400
?>
Пример #2 Выделение курсивом слова в тексте
<?php
// В данном примере preg_quote($word) используется, чтобы
// избежать трактовки символа '*' как спец. символа.
$textbody = "Эту книгу *очень* тяжело найти.";
$word = "*очень*";
$textbody = preg_replace ("/" . preg_quote($word, '/') . "/",
"<i>" . $word . "</i>",
$textbody);
?>
Примечания
Замечание: Эта функция безопасна для обработки данных в двоичной форме.
Коментарии
Wondering why your preg_replace fails, even if you have used preg_quote?
Try adding the delimiter / - preg_quote($string, '/');
To escape characters with special meaning, like: .-[]() and so on, use \Q and \E.
For example:
<?php echo ( preg_match('/^'.( $myvar = 'te.t' ).'$/i', 'test') ? 'match' : 'nomatch' ); ?>
Will result in: match
But:
<?php echo ( preg_match('/^\Q'.( $myvar = 'te.t' ).'\E$/i', 'test') ? 'match' : 'nomatch' ); ?>
Will result in: nomatch
List of specials is incomplete:
--- sample code ---
$specials = '.\+*?[^]$(){}=!<>|:-';
for ($i = 0; $i <= 255; $i++) {
if (chr($i) !== preg_quote(chr($i))) {
printf("Character 0x%02x quoted%s\n",
$i,
(strpos($specials, chr($i)) === FALSE) ? ' (+)' : '');
} /* if */
} /* for */
--- sample code ---
--- output ---
Character 0x00 quoted (+)
Character 0x21 quoted
Character 0x24 quoted
Character 0x28 quoted
Character 0x29 quoted
Character 0x2a quoted
Character 0x2b quoted
Character 0x2d quoted
Character 0x2e quoted
Character 0x3a quoted
Character 0x3c quoted
Character 0x3d quoted
Character 0x3e quoted
Character 0x3f quoted
Character 0x5b quoted
Character 0x5c quoted
Character 0x5d quoted
Character 0x5e quoted
Character 0x7b quoted
Character 0x7c quoted
Character 0x7d quoted
--- output ---
It should be noted that the forward slash is not escaped. Since many regexes are surrounded by forward slashes, if you have one in your regex as text you must escape it yourself otherwise it'll terminat the regex.To have a higher level control of what your pattern looks like, try T-Regx:
Pattern::inject('This is (my|our) pattern: @', [$_GET['name']]);
I discovered that, in addition to escaping the special regular expression characters, preg_quote() encodes the NUL byte to its octal representation:
<?php
var_dump(preg_quote("\0"));
?>
Output:
string(4) "\000"