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

Copy
1<?php
2
3/**
4 * PHPのJSON_PRETTY_PRINT定数の使用例を示します。
5 * この定数はjson_encode()関数と組み合わせて使用し、JSON出力を見やすく整形するために利用されます。
6 */
7function demonstrateJsonPrettyPrint(): void
8{
9    // JSONとしてエンコードするサンプルデータを用意します。
10    // 連想配列や配列、スカラー値など、様々なデータ型を含めることができます。
11    $sampleData = [
12        'productName' => 'スマートフォンX',
13        'price' => 799.99,
14        'available' => true,
15        'features' => ['5G対応', '防水', '高解像度カメラ'],
16        'specifications' => [
17            'os' => 'Android 13',
18            'storage' => '128GB',
19            'ram' => '8GB'
20        ],
21        'reviews' => [
22            [
23                'user' => '山田',
24                'rating' => 5,
25                'comment' => '非常に使いやすいです！'
26            ],
27            [
28                'user' => '鈴木',
29                'rating' => 4,
30                'comment' => 'バッテリーの持ちが良いです。'
31            ]
32        ]
33    ];
34
35    echo "--- 整形なしのJSON出力 ---" . PHP_EOL;
36    // JSON_PRETTY_PRINT定数を使用しない場合、JSONは1行で出力されます。
37    // これはデータ転送には効率的ですが、人間が読むには適していません。
38    $jsonCompact = json_encode($sampleData);
39    echo $jsonCompact . PHP_EOL . PHP_EOL;
40
41    echo "--- 整形ありのJSON出力 (JSON_PRETTY_PRINTを使用) ---" . PHP_EOL;
42    // json_encode()関数の第二引数にJSON_PRETTY_PRINT定数を渡すことで、
43    // JSON出力がインデントされ、改行が追加されて読みやすくなります。
44    $jsonPretty = json_encode($sampleData, JSON_PRETTY_PRINT);
45    echo $jsonPretty . PHP_EOL;
46}
47
48// 関数を実行し、JSON_PRETTY_PRINTの動作を確認します。
49demonstrateJsonPrettyPrint();
50

PHPのJSON_PRETTY_PRINT定数は、json_encode()関数と組み合わせて使用される特別な値です。この定数の主な役割は、JSON形式の出力を見やすく整形することにあります。

通常、json_encode()関数はPHPのデータ（配列やオブジェクトなど）をJSON文字列に変換しますが、その際に出力されるJSONは、データ転送の効率を優先して改行やインデントなしの1行の文字列になります。これは機械が処理するには適していますが、人間が内容を読み解く際には非常に読みにくいものです。

そこで、json_encode()関数の第二引数にJSON_PRETTY_PRINT定数を指定すると、出力されるJSON文字列は自動的にインデントされ、階層構造が分かりやすくなるように改行が追加されます。これにより、複雑なJSONデータでも視覚的に把握しやすくなり、開発やデバッグの効率が向上します。

この定数自体には引数はなく、何らかの値を直接返すこともありません。json_encode()関数の動作を変更するためのオプションフラグとして機能します。システム開発においてAPI連携やデータ入出力でJSONを扱う際に、この定数を知っていると、データの確認作業をスムーズに行うことができるでしょう。

Copy
1<?php
2
3/**
4 * PHPのJSON_PRETTY_PRINT定数の使用例を示します。
5 * キーワード「php json pretty print not working」は、
6 * json_encode関数の第2引数にJSON_PRETTY_PRINT定数を指定し忘れている場合に
7 * 発生することが多い問題を指します。
8 * このサンプルコードでは、整形なしのJSON出力と整形ありのJSON出力を比較して示します。
9 */
10function demonstrateJsonPrettyPrint(): void
11{
12    // エンコードするサンプルデータ
13    $data = [
14        'id' => 123,
15        'name' => 'サンプル ユーザー',
16        'email' => 'sample@example.com',
17        'roles' => ['admin', 'guest'],
18        'isActive' => true,
19        'settings' => [
20            'theme' => 'dark',
21            'notifications' => [
22                'email' => true,
23                'sms' => false,
24            ],
25        ],
26    ];
27
28    echo "--- 整形なしのJSON出力 (デフォルト) ---\n";
29    // JSON_PRETTY_PRINT を指定しない場合、一行で出力され、人間には読みにくい
30    $unformattedJson = json_encode($data);
31    if ($unformattedJson === false) {
32        echo "エラー: JSONエンコードに失敗しました - " . json_last_error_msg() . "\n";
33        return;
34    }
35    echo $unformattedJson . "\n\n";
36
37    echo "--- 整形ありのJSON出力 (JSON_PRETTY_PRINT 使用) ---\n";
38    // JSON_PRETTY_PRINT を第2引数に指定することで、
39    // 人間が読みやすいようにインデントと改行が追加される
40    $formattedJson = json_encode($data, JSON_PRETTY_PRINT);
41    if ($formattedJson === false) {
42        echo "エラー: JSONエンコードに失敗しました - " . json_last_error_msg() . "\n";
43        return;
44    }
45    echo $formattedJson . "\n";
46}
47
48// 関数を実行し、出力結果を確認します
49demonstrateJsonPrettyPrint();
50

PHPのJSON_PRETTY_PRINTは、JSON形式のデータを人間が読みやすいように整形して出力するための定数です。この定数自体は値を持つだけであり、関数のように引数を取ったり、特定の値を戻したりすることはありません。主にjson_encode関数の第2引数として使用されます。

通常、json_encode関数でデータをJSON形式に変換すると、デフォルトでは全ての情報が一つの長い文字列として出力され、改行やインデントがないため、特に複雑なデータ構造では内容を把握しにくくなります。

サンプルコードでは、整形なしのJSON出力と、JSON_PRETTY_PRINT定数を指定した整形ありのJSON出力を比較しています。json_encode関数の第2引数にJSON_PRETTY_PRINTを指定することで、JSONデータに適切なインデントと改行が自動的に追加され、階層構造が視覚的に分かりやすく、人間が読みやすい形式で出力されます。

「php json pretty print not working」というキーワードで検索される問題は、多くの場合、json_encode関数にこのJSON_PRETTY_PRINT定数を渡し忘れていることが原因です。この定数を正しく指定することで、デバッグ時やログ出力などでJSONデータの可読性を大幅に向上させ、開発作業を効率化することができます。