【PHP8.x】addcslashes関数の使い方

Copy
1<?php
2
3// addcslashes関数は、指定された文字の前にバックスラッシュを追加してエスケープします。
4// これは、文字列内の特定の文字が特別な意味を持つ文脈（例: 正規表現パターン、JavaScript文字列など）で、
5// それらを文字通り扱いたい場合に役立ちます。
6
7// 1. エスケープしたい元の文字列を定義します。
8$originalString = "Hello, World! This is $100 and [Important] stuff.";
9
10// 2. エスケープする文字のセットを定義します。
11// ここでは、カンマ(,), ドル記号($), 左角括弧([), 感嘆符(!) をエスケープ対象とします。
12// 文字範囲も指定できます（例: 'A..Z' は大文字アルファベットすべてを意味します）。
13$charactersToEscape = ",$![";
14
15// 3. addcslashes関数を使って文字列をエスケープします。
16// $originalString 内で $charactersToEscape に含まれる各文字の前にバックスラッシュが追加されます。
17$escapedString = addcslashes($originalString, $charactersToEscape);
18
19// 4. エスケープ前とエスケープ後の文字列を出力して比較します。
20echo "元の文字列: " . $originalString . PHP_EOL;
21echo "エスケープ対象文字: '" . $charactersToEscape . "'" . PHP_EOL;
22echo "エスケープ後の文字列: " . $escapedString . PHP_EOL;
23
24// 実行結果の例:
25// 元の文字列: Hello, World! This is $100 and [Important] stuff.
26// エスケープ対象文字: ',$!['
27// エスケープ後の文字列: Hello\, World\! This is \$100 and \[Important] stuff.
28
29?>

PHPのaddcslashes関数は、指定された文字列の中から特定の文字を選び出し、その文字の前にバックスラッシュを追加してエスケープする際に使用されます。この処理は、正規表現パターンやJavaScript文字列のように、文字列内の特定の文字が特別な意味を持つ文脈で、それらを文字通り扱いたい場合に非常に役立ちます。

この関数は二つの引数を取ります。一つ目の引数$stringには、エスケープ処理を施したい元の文字列を指定します。二つ目の引数$charactersには、エスケープ対象とする文字のセットを文字列で指定します。例えば、",$!["のように特定の文字を列挙したり、"A..Z"のように文字の範囲を指定したりすることも可能です。関数は、エスケープ処理が施された新しい文字列を戻り値として返します。元の文字列自体は変更されません。

サンプルコードでは、「Hello, World! This is $100 and [Important] stuff.」という元の文字列に対して、カンマ(,), ドル記号($), 左角括弧([), 感嘆符(!)をエスケープ対象として指定しています。addcslashes関数が実行されると、元の文字列の中でこれらの指定された文字の前にバックスラッシュが挿入され、「Hello, World! This is $100 and [Important] stuff.」というエスケープされた新しい文字列が生成されます。このように、意図しない解釈を防ぎ、安全に文字列を扱いたい場合に活用される便利な関数です。

Copy
1<?php
2
3/**
4 * PHPの addcslashes() 関数と addslashes() 関数の違いを比較するサンプルコードです。
5 *
6 * addslashes() は、シングルクォート(')、ダブルクォート(")、バックスラッシュ(\)、
7 * およびNULLバイト(\0)の4つの特定の文字のみをエスケープします。
8 * これは主にデータベースに文字列を安全に挿入するために過去に使われましたが、現在はプリペアドステートメントが推奨されます。
9 *
10 * addcslashes() は、エスケープする文字や文字の範囲を自由に指定できるため、より柔軟なエスケープ処理が可能です。
11 * 例えば、特定のアルファベット、数字、記号などを任意にエスケープできます。
12 */
13function compareCslashesAndSlahses(): void
14{
15    // 比較に使用する元の文字列
16    $originalString = "It's a \"test\" string with a \\backslash and some numbers 123 and letters ABC.";
17
18    echo "元の文字列: " . $originalString . PHP_EOL;
19
20    // --- addslashes() の動作 ---
21    // addslashes() は、固定の文字セット (', ", \, \0) のみをエスケープします。
22    $slashesEscaped = addslashes($originalString);
23    echo "addslashes() の結果: " . $slashesEscaped . PHP_EOL;
24
25    // --- addcslashes() の動作 (特定の文字を指定) ---
26    // 's', 't', 'a' の文字をエスケープするように指定します。
27    // addslashes() ではエスケープされない文字が対象となることを示します。
28    $specificCharsToEscape = 'sta';
29    $cslashesEscapedSpecific = addcslashes($originalString, $specificCharsToEscape);
30    echo "addcslashes() の結果 (文字 '{$specificCharsToEscape}' を指定): " . $cslashesEscapedSpecific . PHP_EOL;
31
32    // --- addcslashes() の動作 (文字の範囲を指定) ---
33    // 数字 ('0'から'9') と大文字 ('A'から'Z') の範囲をエスケープするように指定します。
34    // このように文字の範囲指定ができるのも addcslashes() の特徴です。
35    $rangeToEscape = '0..9A..Z';
36    $cslashesEscapedRange = addcslashes($originalString, $rangeToEscape);
37    echo "addcslashes() の結果 (範囲 '{$rangeToEscape}' を指定): " . $cslashesEscapedRange . PHP_EOL;
38}
39
40// 上記の比較関数を実行して結果を表示します。
41compareCslashesAndSlahses();
42

PHPのaddcslashes()関数は、文字列中の特定の文字や文字の範囲をエスケープするために使用されます。この関数は、最初の引数string $stringで指定された元の文字列に対し、2番目の引数string $charactersで指定された文字の前にバックスラッシュを追加してエスケープ処理を行い、エスケープされた新しい文字列をstring型で返します。

$charactersには、エスケープしたい個別の文字（例: 'abc'）や、文字の範囲（例: 'A..Z'、'0..9'）を指定できるため、非常に柔軟なエスケープ処理が可能です。例えば、サンプルコードでは'sta'という特定の文字や、'0..9A..Z'という数字と大文字の範囲をエスケープする例が示されています。

似た関数にaddslashes()がありますが、addslashes()がシングルクォート、ダブルクォート、バックスラッシュ、NULLバイトの4つの特定の文字のみをエスケープするのに対し、addcslashes()はエスケープする文字を開発者が自由に指定できる点が大きな違いです。このようなエスケープ処理は、特定の出力形式に合わせて文字列を調整する際に役立ちますが、データベースへの挿入などセキュリティが重要な場面では、SQLインジェクション対策としてプリペアドステートメントなどのより安全な方法を用いることが推奨されます。