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

JSON_UNESCAPED_LINE_TERMINATORS定数は、PHPのjson_encode関数が値をJSON形式の文字列に変換する際の、改行文字の扱われ方を制御するための定数です。

通常、JSON文字列では、改行文字（例えば、\nや\r）は特殊文字として認識され、JSONの仕様に従って\\nや\\rのようにエスケープされます。これは、JSONデータの安全な転送と解析を保証するためです。しかし、このJSON_UNESCAPED_LINE_TERMINATORS定数をjson_encode関数の第二引数であるオプションとして指定すると、これらの改行文字はエスケープされることなく、元のままの形式でJSON文字列に含まれるようになります。

この機能は、出力されるJSON文字列の可読性を高めたい場合や、特定のシステムやツールがエスケープされていない改行文字を要求する場合に有用です。例えば、デバッグ時や、改行がそのままの形で表示されることを期待するログ出力などで役立つことがあります。

ただし、JSONの標準的な仕様では改行文字のエスケープが推奨されているため、この定数を使用する際は、生成されたJSONを処理するシステムがエスケープされていない改行文字を正しく扱えることを確認することが重要です。互換性やセキュリティの面で問題が発生しないよう、その影響を十分に理解した上で利用してください。

Copy
1<?php
2$data = "Line one\nLine two";
3$json = json_encode($data, JSON_UNESCAPED_LINE_TERMINATORS);
4echo $json;
5?>

引数なし

引数はありません

int

JSON_UNESCAPED_LINE_TERMINATORSは、json_encode()関数で使用される定数です。この定数を指定すると、JSON文字列内で改行文字（LFやCR）がエスケープされずにそのまま出力されるようになります。