PHPマニュアル/PEARマニュアル | ユーザフォーラムで議論/質問 | マニュアル検索 | ハイライト | ハイライトオフ | ポータル | php spot

json_encode - 値を JSON 形式にして返す | JavaScript入門&応用&リファレンスなら「JavaScriptist」

  

json_encode

(PHP 5 >= 5.2.0, PHP 7, PECL json >= 1.2.0)

json_encode値を JSON 形式にして返す

説明

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

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

The encoding is affected by the supplied options and additionally the encoding of float values depends on the value of serialize_precision.

パラメータ

value

エンコードする値。 resource 型以外の任意の型を指定できます。

すべての文字列データは、UTF-8 エンコードされていなければいけません。

注意:

PHP の実装は、 » RFC 7159 の JSON のスーパーセットです。

options

JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS, JSON_NUMERIC_CHECK, JSON_PRETTY_PRINT, JSON_UNESCAPED_SLASHES, JSON_FORCE_OBJECT, JSON_PRESERVE_ZERO_FRACTION, JSON_UNESCAPED_UNICODE, JSON_PARTIAL_OUTPUT_ON_ERROR からなるビットマスク。 各定数の意味については JSON 定数のページ に説明があります。

depth

最大の深さを設定します。正の数でなければいけません。

返り値

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

変更履歴

バージョン 説明
7.1.0 double 値をエンコードする際に、 precision ではなく serialize_precision を使うようになりました。
5.6.6 option パラメータに JSON_PRESERVE_ZERO_FRACTION が追加されました。
5.5.0 パラメータ depth が追加されました。
5.5.0 JSON_PARTIAL_OUTPUT_ON_ERROR オプションが追加されました。
5.5.0 The return value on failure was changed from null string to FALSE.
5.4.0 optionJSON_PRETTY_PRINTJSON_UNESCAPED_SLASHES および JSON_UNESCAPED_UNICODE が追加されました。
5.3.3 optionJSON_NUMERIC_CHECK が追加されました。
5.3.0 options パラメータが追加されました。

例1 json_encode() の例

<?php
$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() で、利用中のいくつかのオプションを表示する例

<?php
$a 
= array('<foo>',"'bar'",'"baz"','&blong&'"\xc3\xa9");

echo 
"Normal: ",  json_encode($a), "\n";
echo 
"Tags: ",    json_encode($aJSON_HEX_TAG), "\n";
echo 
"Apos: ",    json_encode($aJSON_HEX_APOS), "\n";
echo 
"Quot: ",    json_encode($aJSON_HEX_QUOT), "\n";
echo 
"Amp: ",     json_encode($aJSON_HEX_AMP), "\n";
echo 
"Unicode: "json_encode($aJSON_UNESCAPED_UNICODE), "\n";
echo 
"All: ",     json_encode($aJSON_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($bJSON_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($cJSON_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($dJSON_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 オプションの例

<?php
echo "Strings representing numbers automatically turned into numbers".PHP_EOL;
$numbers = array('+123123''-123123''1.2e3''0.00001');
var_dump(
 
$numbers,
 
json_encode($numbersJSON_NUMERIC_CHECK)
);
echo 
"Strings containing improperly formatted numbers".PHP_EOL;
$strings = array('+a33123456789''a123');
var_dump(
 
$strings,
 
json_encode($stringsJSON_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 シーケンシャルな配列とそうでない配列の例

<?php
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 オプションの例

<?php
var_dump
(json_encode(12.0JSON_PRESERVE_ZERO_FRACTION));
var_dump(json_encode(12.0));
?>

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

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

注意

注意:

エンコードに失敗した場合は、json_last_error() を使ってエラーの内容を調べることができます。

注意:

配列をエンコードする場合、もし配列のキーが 0 からはじまる連続した数値でなければ、 すべてのキーを文字列としてエンコードします。 そして、個々のキー/値のペアを明示的に指定します。

注意:

JSON エンコーダーのリファレンス実装と同様、 stringintegerfloat そして boolean を入力として渡したときに json_encode() が生成する JSON はシンプルな値 (オブジェクトでもないし配列でもないもの) となります。 大半のエンコーダーはこういった値を妥当な JSON として扱いますが、中にはそうでないものもあります。 そのため、現時点ではこの仕様は不明瞭です。

要するに、json_encode() で生成した JSON が、あなたの使おうとしているデコーダーでデコードできるかどうかを常に確認する必要があるということです。

参考


忘却曲線を使ってこの関数を確実に記憶に残す

フォーラムで「json_encode - 値を JSON 形式にして返す」について話す
各種マニュアル: PHPマニュアル | PEARマニュアル | Smarty(英語)マニュアル | PHP-GTKマニュアル | json_encode - 値を JSON 形式にして返す」をGoogle検索
copyright © 1997-2024 PHP ドキュメント作成グループ(ライセンス). provided by php spot. マニュアル: