preg_quote

(PHP 4, PHP 5, PHP 7, PHP 8)

preg_quoteЭкранирует символы в регулярных выражениях

Описание

preg_quote(string $str, ?string $delimiter = null): string

Функция preg_quote() принимает строку str и добавляет обратный слеш перед каждым служебным символом. Это бывает полезно, если в составлении шаблона участвуют строковые переменные, значение которых в процессе работы скрипта может меняться.

В регулярных выражениях служебными считаются следующие символы: . \ + * ? [ ^ ] $ ( ) { } = ! < > | : - #

Обратите внимание, что символ / не является служебным.

Замечание:

Обратите внимание, что preg_quote() не предназначена для применения к строкам $replacement функции preg_replace() и т.д.

Список параметров

str

Входная строка.

delimiter

В случае, если указан необязательный параметр delimiter, он будет также экранироваться. Это удобно для экранирования разделителя, который используется в PCRE-функциях. Наиболее распространённым разделителем является символ /.

Возвращаемые значения

Возвращает экранированную строку.

Список изменений

Версия Описание
7.3.0 Символ # теперь экранируется
7.2.0 delimiter теперь допускает значение null.

Примеры

Пример #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);
?>

Примечания

Замечание: Функция безопасна для обработки данных в двоичной форме.

Смотрите также

Добавить

Примечания пользователей 6 notes

up
74
Anonymous
17 years ago
Wondering why your preg_replace fails, even if you have used preg_quote?Try adding the delimiter / - preg_quote($string, '/');
up
16
zooly
16 years ago
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: matchBut:<?php echo ( preg_match('/^\Q'.( $myvar = 'te.t' ).'\E$/i', 'test') ? 'match' : 'nomatch' ); ?>Will result in: nomatch
up
6
ed at happysoftware dot com
6 years ago
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.
up
4
rwillmann at crooce dot com
7 years ago
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 quotedCharacter 0x24 quotedCharacter 0x28 quotedCharacter 0x29 quotedCharacter 0x2a quotedCharacter 0x2b quotedCharacter 0x2d quotedCharacter 0x2e quotedCharacter 0x3a quotedCharacter 0x3c quotedCharacter 0x3d quotedCharacter 0x3e quotedCharacter 0x3f quotedCharacter 0x5b quotedCharacter 0x5c quotedCharacter 0x5d quotedCharacter 0x5e quotedCharacter 0x7b quotedCharacter 0x7c quotedCharacter 0x7d quoted--- output ---
up
2
Anonymous
4 years ago
I discovered that, in addition to escaping the special regular expression characters, preg_quote() encodes the NUL byte to its octal representation:<?phpvar_dump(preg_quote("\0"));?>Output:string(4) "\000"
up
-3
rawr at t-regx dot com
4 years ago
To have a higher level control of what your pattern looks like, try T-Regx:Pattern::inject('This is (my|our) pattern: @', [$_GET['name']]);
To Top