説明

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

preg_quote() は、str を引数とし、正規表現構文の特殊文字の前にバックスラッシュを挿入します。この関数は、実行時に生成される文字列をパターンとしてマッチングを行う必要があり、その文字列には正規表現の特殊文字が含まれているかも知れない場合に有用です。

正規表現の特殊文字は、次のものです。 . \ + * ? [ ^ ] $ ( ) { } = ! < > | : - #

/ は正規表現の特殊文字ではないことに注意しましょう。

注意:
preg_quote() は、 preg_replace() などにおける $replacement 文字列に使うことを想定したものではありません。

パラメータ

str: 入力文字列。
delimiter: オプションの delimiter を指定すると、ここで指定した文字もエスケープされます。これは、PCRE 関数が使用するデリミタをエスケープする場合に便利です。/ がデリミタとしては最も一般的に使用されています。

戻り値

クォートされた (エスケープした) 文字列を返します。

変更履歴

バージョン説明

7.3.0 # 文字がクォートされるようになりました。

7.2.0 delimiter は、nullable になりました。

バージョン	説明
7.3.0	`#` 文字がクォートされるようになりました。
7.2.0	`delimiter` は、nullable になりました。

例

例1 preg_quote() の例

<?php
$keywords = '$40 for a g3/400';
$keywords = preg_quote($keywords, '/');
echo $keywords; // \$40 for a g3\/400 を返します
?>

例2 テキスト内の単語の斜体変換

<?php
// この例では、preg_quote($word) を使って、アスタリスクが
// 正規表現での特殊な意味を帯びないようにしています

$textbody = "This book is *very* difficult to find.";
$word = "*very*";
$textbody = preg_replace ("/" . preg_quote($word, '/') . "/",
                          "<i>" . $word . "</i>",
                          $textbody);
?>

注意

注意: この関数はバイナリデータに対応しています。

参考

PCRE パターン
escapeshellcmd() - シェルのメタ文字をエスケープする