PHP 8.5.0 Alpha 1 available for testing

preg_quote

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

preg_quoteProtección de caracteres especiales de expresiones regulares

Descripción

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

preg_quote() añade una barra invertida antes de cada carácter de la cadena str que forma parte de la sintaxis de expresiones regulares. Esto es muy útil si se tiene una cadena que va a servir como máscara, pero que es generada durante la ejecución.

Los caracteres especiales que serán protegidos son los siguientes: . \ + * ? [ ^ ] $ ( ) { } = ! < > | : - #

Tenga en cuenta que / no es un carácter especial de expresión regular.

Nota:

Tenga en cuenta que preg_quote() no está destinado a ser aplicado a las cadenas $replacement de preg_replace() etc.

Parámetros

str

La cadena de entrada.

delimiter

Si el argumento opcional delimiter es proporcionado, también será escapado. Esto es práctico para escapar el delimitador requerido por las funciones PCRE. La barra / es el delimitador más común.

Valores devueltos

Retorna la cadena protegida.

Historial de cambios

Versión Descripción
7.3.0 El carácter # ahora es protegido
7.2.0 delimiter ahora es nullable.

Ejemplos

Ejemplo #1 Ejemplo con preg_quote()

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

Ejemplo #2 Poner en cursiva una palabra en un texto

<?php
// En este ejemplo, preg_quote($word) sirve para evitar que los asteriscos
// tengan un valor especial en la expresión regular.

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

Notas

Nota: Esta función es segura binariamente.

Ver también

add a note

User Contributed Notes 6 notes

up
76
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
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
5
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 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
1
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:

<?php
var_dump
(preg_quote("\0"));
?>

Output:

string(4) "\000"
up
-4
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