関数・クラス解説

json_encode

version:PHP 5 >= 5.2.0, PHP 7, PECL json (公式)

値を JSON 形式にして返す

公式リファレンス

書式

json_encode ( mixed $value [, int $options = 0 [, int $depth = 512 ]] ) : string|false

説明

与えられた value を JSON 形式にした文字列を返します。

エンコーディングは、options の指定によって影響を受けます。 さらに、浮動小数点のエンコーディングは、 serialize_precision の値によっても影響を受けます。

パラメータ

value
エンコードする値。 リソース 型以外の任意の型を指定できます。 すべての文字列データは、UTF-8 エンコードされていなければいけません。
注意: PHP の実装は、 » RFC 7159 の JSON のスーパーセットです。
options
JSON_FORCE_OBJECT, JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS, JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE, JSON_NUMERIC_CHECK, JSON_PARTIAL_OUTPUT_ON_ERROR, JSON_PRESERVE_ZERO_FRACTION, JSON_PRETTY_PRINT, JSON_UNESCAPED_LINE_TERMINATORS, JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE, JSON_THROW_ON_ERROR からなるビットマスク。 各定数の意味については JSON 定数のページ に説明があります。
depth
最大の深さを設定します。正の数でなければいけません。

返値

成功した場合に、JSON エンコードされた文字列を返します。 失敗した場合に FALSE を返します。

注意

注意: エンコードに失敗した場合は、json_last_error() を使ってエラーの内容を調べることができます。
注意: 配列をエンコードする場合、もし配列のキーが 0 からはじまる連続した数値でなければ、 すべてのキーを文字列としてエンコードします。 そして、個々のキー/値のペアを明示的に指定します。
注意: JSON エンコーダーのリファレンス実装と同様、 string や int、 float そして bool を入力として渡したときに json_encode() が生成する JSON はシンプルな値 (オブジェクトでもないし配列でもないもの) となります。 大半のエンコーダーはこういった値を妥当な JSON として扱いますが、中にはそうでないものもあります。 そのため、現時点ではこの仕様は不明瞭です。 要するに、json_encode() で生成した JSON が、あなたの使おうとしているデコーダーでデコードできるかどうかを常に確認する必要があるということです。

更新履歴

バージョン 説明
7.3.0 options パラメータに JSON_THROW_ON_ERROR が追加されました。
7.2.0 options パラメータに JSON_INVALID_UTF8_IGNORE と JSON_INVALID_UTF8_SUBSTITUTE が追加されました。
7.1.0 options パラメータに JSON_UNESCAPED_LINE_TERMINATORS が追加されました。
7.1.0 double 値をエンコードする際に、 precision ではなく serialize_precision を使うようになりました。

サンプル

例1 json_encode() の例

$arr = array('a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5); echo json_encode($arr);

上の例の出力は以下となります。

{"a":1,"b":2,"c":3,"d":4,"e":5}

例2 json_encode() で、利用中のいくつかのオプションを表示する例

$a = array('',"'bar'",'"baz"','&blong&', "\xc3\xa9"); echo "Normal: ",  json_encode($a), "\n"; echo "Tags: ",    json_encode($a, JSON_HEX_TAG), "\n"; echo "Apos: ",    json_encode($a, JSON_HEX_APOS), "\n"; echo "Quot: ",    json_encode($a, JSON_HEX_QUOT), "\n"; echo "Amp: ",     json_encode($a, JSON_HEX_AMP), "\n"; echo "Unicode: ", json_encode($a, JSON_UNESCAPED_UNICODE), "\n"; echo "All: ",     json_encode($a, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE), "\n\n"; $b = array(); echo "Empty array output as array: ", json_encode($b), "\n"; echo "Empty array output as object: ", json_encode($b, JSON_FORCE_OBJECT), "\n\n"; $c = array(array(1,2,3)); echo "Non-associative array output as array: ", json_encode($c), "\n"; echo "Non-associative array output as object: ", json_encode($c, JSON_FORCE_OBJECT), "\n\n"; $d = array('foo' => 'bar', 'baz' => 'long'); echo "Associative array always output as object: ", json_encode($d), "\n"; echo "Associative array always output as object: ", json_encode($d, JSON_FORCE_OBJECT), "\n\n";

上の例の出力は以下となります。

Normal: ["<foo>","'bar'","\"baz\"","&blong&","\u00e9"] Tags: ["\u003Cfoo\u003E","'bar'","\"baz\"","&blong&","\u00e9"] Apos: ["<foo>","\u0027bar\u0027","\"baz\"","&blong&","\u00e9"] Quot: ["<foo>","'bar'","\u0022baz\u0022","&blong&","\u00e9"] Amp: ["<foo>","'bar'","\"baz\"","\u0026blong\u0026","\u00e9"] Unicode: ["<foo>","'bar'","\"baz\"","&blong&","e"] All: ["\u003Cfoo\u003E","\u0027bar\u0027","\u0022baz\u0022","\u0026blong\u0026","e"] Empty array output as array: [] Empty array output as object: {} Non-associative array output as array: [[1,2,3]] Non-associative array output as object: {"0":{"0":1,"1":2,"2":3}} Associative array always output as object: {"foo":"bar","baz":"long"} Associative array always output as object: {"foo":"bar","baz":"long"}

例3 JSON_NUMERIC_CHECK オプションの例

echo "Strings representing numbers automatically turned into numbers".PHP_EOL; $numbers = array('+123123', '-123123', '1.2e3', '0.00001'); var_dump(  $numbers,  json_encode($numbers, JSON_NUMERIC_CHECK) ); echo "Strings containing improperly formatted numbers".PHP_EOL; $strings = array('+a33123456789', 'a123'); var_dump(  $strings,  json_encode($strings, JSON_NUMERIC_CHECK) );

上の例の出力は、たとえば以下のようになります。

Strings representing numbers automatically turned into numbers array(4) { [0]=> string(7) "+123123" [1]=> string(7) "-123123" [2]=> string(5) "1.2e3" [3]=> string(7) "0.00001" } string(28) "[123123,-123123,1200,1.0e-5]" Strings containing improperly formatted numbers array(2) { [0]=> string(13) "+a33123456789" [1]=> string(4) "a123" } string(24) "["+a33123456789","a123"]"

例4 シーケンシャルな配列とそうでない配列の例

echo "Sequential array".PHP_EOL; $sequential = array("foo", "bar", "baz", "blong"); var_dump(  $sequential,  json_encode($sequential) ); echo PHP_EOL."Non-sequential array".PHP_EOL; $nonsequential = array(1=>"foo", 2=>"bar", 3=>"baz", 4=>"blong"); var_dump(  $nonsequential,  json_encode($nonsequential) ); echo PHP_EOL."Sequential array with one key unset".PHP_EOL; unset($sequential[1]); var_dump(  $sequential,  json_encode($sequential) );

上の例の出力は以下となります。

Sequential array array(4) { [0]=> string(3) "foo" [1]=> string(3) "bar" [2]=> string(3) "baz" [3]=> string(5) "blong" } string(27) "["foo","bar","baz","blong"]" Non-sequential array array(4) { [1]=> string(3) "foo" [2]=> string(3) "bar" [3]=> string(3) "baz" [4]=> string(5) "blong" } string(43) "{"1":"foo","2":"bar","3":"baz","4":"blong"}" Sequential array with one key unset array(3) { [0]=> string(3) "foo" [2]=> string(3) "baz" [3]=> string(5) "blong" } string(33) "{"0":"foo","2":"baz","3":"blong"}"

例5 JSON_PRESERVE_ZERO_FRACTION オプションの例

var_dump(json_encode(12.0, JSON_PRESERVE_ZERO_FRACTION)); var_dump(json_encode(12.0));

上の例の出力は以下となります。

string(4) "12.0" string(2) "12"

参考

  • JsonSerializable
  • json_decode() - JSON 文字列をデコードする
  • json_last_error() - 直近に発生したエラーを返す
  • serialize() - 値の保存可能な表現を生成する
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール