preg_quote

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

preg_quoteProtection des caractères spéciaux des expressions régulières

Description

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

preg_quote() ajoute un antislash devant chaque caractère de la chaîne str faisant partie de la syntaxe des expressions régulières. Cela est très utile si vous avez une chaîne qui va servir de masque, mais qui est générée durant l'exécution.

Les caractères spéciaux qui seront protégés sont les suivants : . \ + * ? [ ^ ] $ ( ) { } = ! < > | : - #

Notez que / n'est pas un caractère spécial d'expression régulière.

Note:

Notez que preg_quote() n'est pas destiné à être appliqué aux chaînes de caractères $replacement de preg_replace() etc.

Liste de paramètres

str

La chaîne d'entrée.

delimiter

Si l'argument optionnel delimiter est fourni, il sera aussi échappé. Ceci est pratique pour échapper le délimiteur requis par les fonctions PCRE. Le slash / est le délimiteur le plus répandu.

Valeurs de retour

Retourne la chaîne protégée.

Historique

Version Description
7.3.0 Le caractère # est maintenant protégé
7.2.0 delimiter est désormais nullable.

Exemples

Exemple #1 Exemple avec preg_quote()

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

Exemple #2 Mise en italique d'un mot dans un texte

<?php
// Dans cet exemple, preg_quote($word) sert à éviter que les astérisques
// prennent une valeur particulière dans l'expression rationnelle.

$textbody = "Ce livre est *très* difficile à trouver.";
$word = "*très*";
$textbody = preg_replace ("/" . preg_quote($word, '/') . "/",
"<i>" . $word . "</i>",
$textbody);
?>

Notes

Note: Cette fonction gère les chaînes binaires.

Voir aussi

add a note

User Contributed Notes 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