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