preg_quote

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

preg_quoteEscapa caracteres de expressão regular

Descrição

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

preg_quote() insere uma barra invertida na frente de cada caractere de str que seja parte da sintaxe de expressões regulares. Isto é útil caso exista uma string no momento da execução que precisa ser correspondida a algum texto e que possa conter caracteres especiais de expressões regulares.

Os caracteres especiais de expressões regulares são: . \ + * ? [ ^ ] $ ( ) { } = ! < > | : - #

Observe que / não é um caractere especial de expressões regulares.

Nota:

Veja que preg_quote() não foi projetada para ser aplicada às strings de substituição da função preg_replace() e outras.

Parâmetros

str

A string de entrada.

delimiter

Se o parâmetro opcional delimiter for especificado, o ele também será escapado. Isto é útil para escapar o delimitador requerido pelas funções PCRE. A barra / é o delimitador mais comum.

Valor Retornado

Retorna a string escapada.

Registro de Alterações

Versão Descrição
7.3.0 O caractere # agora é escapado.
7.2.0 delimiter agora pode ser nulo.

Exemplos

Exemplo #1 Exemplo de preg_quote()

<?php
$keywords
= '$40 por um g3/400';
$keywords = preg_quote($keywords, '/');
echo
$keywords; // retorna \$40 por um g3\/400
?>

Exemplo #2 Transformando uma palavra em itálico dentro de um texto

<?php
// Neste exemplo, preg_quote($word) é usada para impedir que
// os asteriscos tenham um significado especial na expressão
// regular.

$textbody = "Este livro é *muito* difícil de encontrar.";
$word = "*muito*";
$textbody = preg_replace ("/" . preg_quote($word, '/') . "/",
"<i>" . $word . "</i>",
$textbody);
?>

Notas

Nota: Esta função é compatível com dados binários.

Veja Também

adicione uma nota

Notas Enviadas por Usuários (em inglês) 6 notes

up
73
Anonymous
16 years ago
Wondering why your preg_replace fails, even if you have used preg_quote?

Try adding the delimiter / - preg_quote($string, '/');
up
4
Anonymous
3 years ago
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"
up
16
zooly
15 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: match

But:

<?php echo ( preg_match('/^\Q'.( $myvar = 'te.t' ).'\E$/i', 'test') ? 'match' : 'nomatch' ); ?>

Will result in: nomatch
up
6
ed at happysoftware dot com
5 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 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 ---
up
-3
rawr at t-regx dot com
3 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