PHPのaddcslashes()関数の使い方を解説！文字列にバックスラッシュを付加する方法

PHPのaddcslashes()関数は、指定した文字の前にバックスラッシュ（\）を付加した文字列を返す関数です。C言語スタイルのエスケープ処理に相当し、単一の文字だけでなく「a..r」のような文字範囲を指定してまとめてエスケープできるのが特徴です。

注意：addcslashes()関数は大文字と小文字を区別します。そのため、「W」を指定しても小文字の「w」はエスケープされません。

構文

addcslashes(str, characters)

パラメータ

• str − エスケープ処理の対象となる文字列

• characters − エスケープしたい文字、またはエスケープ対象となる文字の範囲（例：「a..r」）

戻り値

addcslashes()関数は、指定された文字の直前にバックスラッシュが付加された文字列を返します。

使用例1：特定の文字をエスケープする

次の例では、文字列中の「W」の前にバックスラッシュを付加しています。

<?php
    $str = addcslashes("First World!", "W");
    echo($str);
?>

出力結果

First \World!

「World」の先頭にある大文字の「W」だけがエスケープされていることが確認できます。

使用例2：文字の範囲を指定してエスケープする

次の例では、「a」から「r」までの範囲（a..r）に含まれるすべての文字をエスケープしています。

<?php
    $str = addcslashes("First World!", "a..r");
    echo($str);
?>

出力結果

F\i\rst W\o\r\l\d!

このように、範囲指定を使うことでアルファベットの連続した文字を一括してエスケープできます。範囲内に含まれる「i」「r」「o」「l」「d」などがそれぞれバックスラッシュ付きになっている点に注目してください。

まとめ

addcslashes()関数は、特定の文字や文字範囲の前にバックスラッシュを付けてエスケープ処理を行うための関数です。大文字・小文字を区別すること、また「開始文字..終了文字」の形式で範囲指定が可能なことを覚えておくと、文字列操作の幅が広がります。