downloads | documentation | faq | getting help | mailing lists | licenses | wiki | reporting bugs | php.net sites | conferences | my php.net

search for in the

preg_replace_callback> <preg_match
[edit] Last updated: Fri, 24 May 2013

view this page in

preg_quote

(PHP 4, PHP 5)

preg_quoteProtection des caractères spéciaux des expressions rationnelles

Description

string preg_quote ( string $str [, string $delimiter = NULL ] )

preg_quote() ajoute un antislash devant tous les caractères de la chaîne str. 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 : . \ + * ? [ ^ ] $ ( ) { } = ! < > | : -

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
5.3.0 Le caractère - est maintenant protégé.

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.



preg_replace_callback> <preg_match
[edit] Last updated: Fri, 24 May 2013
 
add a note add a note User Contributed Notes preg_quote - [9 notes]
up
2
billadoid at gmail dot com
1 year ago
If you need to quote everything but a wildcard, maybe this function will come handy to you:

<?php
protected function _ruleOptionIsMatched($option, $subject)
{
   
$option = preg_quote($option, '#');
   
$option = str_replace('\*', '.*', $option);

    if(
preg_match("#^$option$#", $subject))
    {
        return
true;
    }
    else
    {
        return
false;
    }
}
?>
up
1
Anonymous
5 years ago
Wondering why your preg_replace fails, even if you have used preg_quote?

Try adding the delimiter / - preg_quote($string, '/');
up
3
bizzigul at hotmail dot fr
4 years ago
To prevent any problems, try to always use a delimiter that will *almost* not be used inside the regex, such as ` (back quote)

for example: instead of
<?php preg_match('/foo\/bar\//',$somevar); ?>

use

<?php preg_match('`foo/bar/`',$somevar); ?>

it's that simple! like this, you won't have to bother with delimiters anymore...
up
1
zooly
3 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
0
krishoog at gmail dot com
4 years ago
To bizzigul at hotmail dot fr:
It's not a good practice to make somthing work *almost* all of the time. If the input contains a '`' you will still get an error. I recommend using the default delimiter ('/') and also feed this to preg_quote as second argument.
up
0
php at richardneill dot org
1 month ago
preg_quote() only works on the search string, not the replacement string.
But the replacement string isn't always literal, as it can contain backreferences.

There's no function to quote the replacement string, but a workaround is to escape all $ and \ signs:
$replace = str_replace (array('\\','$'),array('\\\\','\$'),$replace); 

For example:
$text = 'Test: *#5*';
$search  = "*#5*";
$replace = "*$5\\1*";
$search = preg_quote($search, "/");
$replace = str_replace (array('\\','$'),array('\\\\','\$'),$replace); 
$new = preg_replace("/$search/", "$replace", $text);
echo "Input:  $text\nOutput: $new\n";

Prints:
Input:   Test: *#5*
Output: Test: *$5\1*
up
0
admin at nilamo dot com
2 years ago
@zooly:

And what if $myvar = 'te\\E.t'?  It will match, when it shouldn't.  That's why you should use preg_quote().
up
0
alexc223 at NOSPAM dot googlemail dot com
3 years ago
Not sure why this note got deleted, but hey lets try again:

As of PHP 5.3, bug #47229 has been fixed and preg_quote *will* escape a hyphen (-). This may effect your code so ensure this is one thing you check when moving to 5.3.
up
0
frostschutz
4 years ago
I wanted to escape a string of characters so I could match them in [], i.e. [.,-!"§$%\\\[\]\^].

Unfortunately preg_quote does not escape the - character which has a special meaning in [], i.e. [a-z].

So I used this hack: make - the delimiter of the expression, i.e.

preg_quote(userinput, "-")
preg_replace("-[$userinput]-u", "", $str)

Apparently using a special char as a delimiter of a regular expression disables this character, i.e. even if it's escaped it's not understood as special character for the expression anymore.

so the pattern "-[a\\-z]-u" matches the characters a, - and z, and not abc...xyz.

It would be nice if preg_quote also escaped characters that have special meanings even if they have this meaning only under certain conditions, such as inside [].

 
show source | credits | sitemap | contact | advertising | mirror sites