【PHP8.x】JSON_HEX_TAG定数の使い方

Copy
1<?php
2
3/**
4 * HTML特殊文字のエスケープに関するJSONエンコードの動作を実演する関数。
5 * システムエンジニアを目指す初心者向けに、JSON_HEX_* 定数の効果を示します。
6 */
7function demonstrateJsonHexConstants(): void
8{
9    // JSONにエンコードするサンプルデータ。
10    // HTMLのタグ、アンパサンド、引用符などを含む文字列を使用します。
11    $data = [
12        'title' => '特別なメッセージ',
13        'content' => 'これは<b>強調</b>されたメッセージです。<p>リンク: <a href="https://example.com?param=value&another=test">ここをクリック</a>。</p>単一引用符 \' と二重引用符 " も含まれます。',
14        'tags' => ['json', 'php', 'html']
15    ];
16
17    echo "--- 元のデータ (JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) ---\n";
18    // デフォルトでは、HTML特殊文字はエスケープされません。
19    // JSON_UNESCAPED_UNICODE: 日本語などのマルチバイト文字をエスケープしない。
20    // JSON_PRETTY_PRINT: 出力を見やすく整形する。
21    echo json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . "\n\n";
22
23    echo "--- JSON_HEX_TAG を使用 (HTMLタグ '<' と '>' を \\u003C, \\u003E にエスケープ) ---\n";
24    echo json_encode($data, JSON_HEX_TAG | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . "\n\n";
25
26    echo "--- JSON_HEX_AMP を使用 ('&' を \\u0026 にエスケープ) ---\n";
27    echo json_encode($data, JSON_HEX_AMP | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . "\n\n";
28
29    echo "--- JSON_HEX_APOS を使用 (単一引用符 ''' を \\u0027 にエスケープ) ---\n";
30    echo json_encode($data, JSON_HEX_APOS | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . "\n\n";
31
32    echo "--- JSON_HEX_QUOT を使用 (二重引用符 '\"' を \\u0022 にエスケープ) ---\n";
33    echo json_encode($data, JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . "\n\n";
34
35    echo "--- 全ての HEX 定数を組み合わせ (JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) ---\n";
36    // 複数の定数を組み合わせるには、ビットOR演算子 '|' を使用します。
37    $allHexFlags = JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT;
38    echo json_encode($data, $allHexFlags | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . "\n\n";
39}
40
41// 関数を実行し、結果を表示します。
42demonstrateJsonHexConstants();
43

PHP 8のJSON_HEX_TAG定数は、JSONデータをエンコードする際に、HTMLのタグを構成する文字である<（小なり記号）と>（大なり記号）をそれぞれ\u003Cと\u003EというUnicodeエスケープシーケンスに変換するための整数型の値です。この定数はjson_encode関数のオプションとして使用され、HTMLコンテンツにJSONを埋め込む際のクロスサイトスクリプティング（XSS）などのセキュリティリスクを軽減する目的で利用されます。

引数はなく、戻り値は整数型です。同様にHTML特殊文字をエスケープする定数として、JSON_HEX_AMPはアンパサンド&を\u0026に、JSON_HEX_APOSは単一引用符'を\u0027に、JSON_HEX_QUOTは二重引用符"を\u0022にエスケープします。これらの定数はjson_encode関数の第2引数に、ビットOR演算子|を使って複数組み合わせて指定することが可能です。

提示されたサンプルコードは、HTMLタグや引用符、アンパサンドを含むデータを、これらのJSON_HEX_*定数を適用せずにエンコードした場合と、それぞれの定数を単独で、または組み合わせて適用した場合とで、出力されるJSONがどのように変化するかを具体的に示しています。これにより、各定数がどのような特殊文字に対してエスケープ処理を施すのかを、初心者のシステムエンジニアの方も視覚的に理解することができます。

Copy
1<?php
2
3/**
4 * JSON_HEX_TAG および関連するJSONエンコードオプションの効果を示す関数。
5 * システムエンジニアを目指す初心者向けに、HTMLタグを含む文字列がJSONにどのように変換されるかを確認します。
6 */
7function demonstrateJsonHexTagUsage(): void
8{
9    // エンコードするサンプルデータ
10    $data = [
11        'title' => '最新のお知らせ',
12        'content' => 'イベント開催！<script>alert("重要")</script>詳細は<a href="#">こちら</a>をご覧ください。',
13        'author' => '担当者 "A"',
14    ];
15
16    echo "--- 元のデータ ---\n";
17    print_r($data);
18    echo "\n";
19
20    // 1. オプションなしでJSONエンコード
21    // この場合、HTMLタグや特殊文字はそのままJSON文字列に含まれます。
22    echo "--- オプションなしでJSONエンコード ---\n";
23    $jsonNoOptions = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
24    echo $jsonNoOptions . "\n\n";
25    // 結果: <script>, <a> タグ、" (ダブルクォート) がそのまま表示されます。
26
27    // 2. JSON_HEX_TAG オプションを使用してJSONエンコード
28    // JSON_HEX_TAG は、全ての < と > を \u003C と \u003E に変換します。
29    // これは、JSONデータがHTMLコンテキストに埋め込まれた際のXSS脆弱性を低減するのに役立ちます。
30    echo "--- JSON_HEX_TAG オプションを使用してJSONエンコード ---\n";
31    $jsonHexTag = json_encode($data, JSON_HEX_TAG | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
32    echo $jsonHexTag . "\n\n";
33    // 結果: < と > がそれぞれ \u003C と \u003E に変換されます。
34
35    // 3. JSON_HEX_TAG と JSON_HEX_QUOT オプションを組み合わせて使用してJSONエンコード
36    // キーワードに関連する JSON_HEX_QUOT オプションも併せて使用します。
37    // JSON_HEX_QUOT は、全てのダブルクォーテーション (") を \u0022 に変換します。
38    echo "--- JSON_HEX_TAG と JSON_HEX_QUOT オプションを組み合わせてJSONエンコード ---\n";
39    $jsonHexTagAndQuot = json_encode($data, JSON_HEX_TAG | JSON_HEX_QUOT | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
40    echo $jsonHexTagAndQuot . "\n\n";
41    // 結果: < と > は \u003C と \u003E に、" (ダブルクォート) は \u0022 に変換されます。
42
43    echo "--- 各オプションの効果のまとめ ---\n";
44    echo "・JSON_HEX_TAG: '<' を '\\u003C' に、'>' を '\\u003E' に変換し、HTMLタグの混入を防ぎます。\n";
45    echo "・JSON_HEX_QUOT: '\"' (ダブルクォート) を '\\u0022' に変換します。\n";
46    echo "これらのオプションは、セキュリティやデータの一貫性を保つために利用されます。\n";
47}
48
49// 関数を実行して、各オプションの効果を確認
50demonstrateJsonHexTagUsage();

PHPのJSON_HEX_TAGは、json_encode関数でJSONデータを生成する際に使用する定数（オプション）です。この定数自体に引数はなく、内部的にはint型の特定の値を持ちます。主に、JSON文字列内に含まれるHTMLの開始タグ<と終了タグ>を、それぞれ\u003Cと\u003EというUnicodeエスケープシーケンスに変換するために使われます。これにより、JSONデータがWebページなどのHTMLコンテキストに埋め込まれた際に、悪意のあるスクリプトが実行されるクロスサイトスクリプティング（XSS）のようなセキュリティリスクを軽減できます。

サンプルコードでは、HTMLタグやダブルクォートを含む文字列をJSONに変換する過程を示しています。まずオプションなしでエンコードすると、これらの特殊文字はそのまま出力されます。次にJSON_HEX_TAGオプションを指定すると、<と>が安全な形式にエスケープされることが確認できます。さらに、キーワードに関連するJSON_HEX_QUOTオプションも組み合わせることで、ダブルクォート（"）も\u0022に変換されます。これらのオプションは、JSONデータを安全かつ一貫した形式で扱うために非常に重要です。