json_encode
(PHP 5 >= 5.2.0, PECL json >= 1.2.0)
json_encode — Возвращает JSON-представление данных
Описание
Возвращает строку, содержащую JSON-представление
value.
Список параметров
-
value -
value- значение, которое будет закодировано. Может быть любого типа за исключением resource.Функция работает только с кодированными в UTF-8 данными.
-
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_UNESCAPED_UNICODE. Смысл этих констант объясняется на странице JSON констант.
Возвращаемые значения
Возвращает JSON закодированную строку (string) в случае успеха или FALSE в случае возникновения ошибки.
Список изменений
| Версия | Описание |
|---|---|
| 5.4.0 |
В options были добавлены константы JSON_PRETTY_PRINT, JSON_UNESCAPED_SLASHES, и JSON_UNESCAPED_UNICODE.
|
| 5.3.3 |
Константа JSON_NUMERIC_CHECK была добавлена в option.
|
| 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 "Обычно: ", json_encode($a), "\n";
echo "Тэги: ", json_encode($a, JSON_HEX_TAG), "\n";
echo "Апострофы: ", json_encode($a, JSON_HEX_APOS), "\n";
echo "Ковычки: ", json_encode($a, JSON_HEX_QUOT), "\n";
echo "Амперсанты: ", json_encode($a, JSON_HEX_AMP), "\n";
echo "Юникод: ", json_encode($a, JSON_UNESCAPED_UNICODE), "\n";
echo "Все: ", json_encode($a, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE), "\n\n";
$b = array();
echo "Отображение пустого массива как массива: ", json_encode($b), "\n";
echo "Отображение пустого массива как объекта: ", json_encode($b, JSON_FORCE_OBJECT), "\n\n";
$c = array(array(1,2,3));
echo "Отображение неассоциативного массива как массива: ", json_encode($c), "\n";
echo "Отображение неассоциативного массива как объекта: ", json_encode($c, JSON_FORCE_OBJECT), "\n\n";
$d = array('foo' => 'bar', 'baz' => 'long');
echo "Ассоциативный массив всегда отображается как объект: ", json_encode($d), "\n";
echo "Ассоциативный массив всегда отображается как объект: ", json_encode($d, JSON_FORCE_OBJECT), "\n\n";
?>
Результат выполнения данного примера:
Обычно: ["<foo>","'bar'","\"baz\"","&blong&","\u00e9"]
Тэги: ["\u003Cfoo\u003E","'bar'","\"baz\"","&blong&","\u00e9"]
Апострофы: ["<foo>","\u0027bar\u0027","\"baz\"","&blong&","\u00e9"]
Ковычки: ["<foo>","'bar'","\u0022baz\u0022","&blong&","\u00e9"]
Амперсанты: ["<foo>","'bar'","\"baz\"","\u0026blong\u0026","\u00e9"]
Unicode: ["<foo>","'bar'","\"baz\"","&blong&","é"]
Все: ["\u003Cfoo\u003E","\u0027bar\u0027","\u0022baz\u0022","\u0026blong\u0026","é"]
Отображение пустого массива как массива: []
Отображение не ассоциативного массива как объекта: {}
Отображение неассоциативного массива как массива: [[1,2,3]]
Отображение неассоциативного массива как объекта: {"0":{"0":1,"1":2,"2":3}}
Ассоциативный массив всегда отображается как объект: {"foo":"bar","baz":"long"}
Ассоциативный массив всегда отображается как объект: {"foo":"bar","baz":"long"}
Пример #3 Пример с последовательными индексами начинающимися с нуля и непоследовательными индексами массивов
<?php
echo "Последовательный массив".PHP_EOL;
$sequential = array("foo", "bar", "baz", "blong");
var_dump(
$sequential,
json_encode($sequential)
);
echo PHP_EOL."Непоследовательный массив".PHP_EOL;
$nonsequential = array(1=>"foo", 2=>"bar", 3=>"baz", 4=>"blong");
var_dump(
$nonsequential,
json_encode($nonsequential)
);
echo PHP_EOL."Последовательный массив с одним удаленным индексом".PHP_EOL;
unset($sequential[1]);
var_dump(
$sequential,
json_encode($sequential)
);
?>
Результат выполнения данного примера:
Последовательный массив
array(4) {
[0]=>
string(3) "foo"
[1]=>
string(3) "bar"
[2]=>
string(3) "baz"
[3]=>
string(5) "blong"
}
string(27) "["foo","bar","baz","blong"]"
Непоследовательный массив
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"}"
Последовательный массив с одним удаленным индексом
array(3) {
[0]=>
string(3) "foo"
[2]=>
string(3) "baz"
[3]=>
string(5) "blong"
}
string(33) "{"0":"foo","2":"baz","3":"blong"}"
Примечания
Замечание:
В случае ошибки кодирования, можно использовать json_last_error() для определения точной ошибки.
Замечание:
При кодировании массива в случае, если его индексы не являются последовательными числами от нуля, то все индексы кодируются в строковые ключи для каждой пары индекс-значение.
Замечание:
Как и эталонный кодировщик JSON, json_encode() будет создавать JSON в виде простого значения (т.е. не объект и не массив), если ему переданы string, integer, float или boolean в качестве входящего значения
value. Большинство декодеров воспринимают эти значения как правильный JSON, но некоторые нет, потому что спецификация неоднозначна на этот счет.Всегда проверяйте, что ваш JSON декодер может правильно обрабатывать данные, которые вы создаете с помощью json_encode().
Смотрите также
- JsonSerializable
- json_decode() - Декодирует JSON строку
- json_last_error() - Возвращает последнюю ошибку
- serialize() - Генерирует пригодное для хранения представление переменной
Коментарии
A note about json_encode automatically quoting numbers:
It appears that the json_encode function pays attention to the data type of the value. Let me explain what we came across:
We have found that when retrieving data from our database, there are occasions when numbers appear as strings to json_encode which results in double quotes around the values.
This can lead to problems within javascript functions expecting the values to be numeric.
This was discovered when were were retrieving fields from the database which contained serialized arrays. After unserializing them and sending them through the json_encode function the numeric values in the original array were now being treated as strings and showing up with double quotes around them.
The fix: Prior to encoding the array, send it to a function which checks for numeric types and casts accordingly. Encoding from then on worked as expected.
Note that if you try to encode an array containing non-utf values, you'll get null values in the resulting JSON string. You can batch-encode all the elements of an array with the array_map function:<?php
$encodedArray = array_map(utf8_encode, $rawArray);
?>
Be careful with floating values in some locales (e.g. russian) with comma (",") as decimal point. Code:
<?php
setlocale(LC_ALL, 'ru_RU.utf8');
$arr = array('element' => 12.34);
echo json_encode( $arr );
?>
Output will be:
--------------
{"element":12,34}
--------------
Which is NOT a valid JSON markup. You should convert floating point variable to strings or set locale to something like "LC_NUMERIC, 'en_US.utf8'" before using json_encode.
I came across the "bug" where running json_encode() over a SimpleXML object was ignoring the CDATA. I ran across http://bugs.php.net/42001 and http://bugs.php.net/41976, and while I agree with the poster that the documentation should clarify gotchas like this, I was able to figure out how to workaround it.
You need to convert the SimpleXML object back into an XML string, then re-import it back into SimpleXML using the LIBXML_NOCDATA option. Once you do this, then you can use json_encode() and still get back the CDATA.
<?php
// Pretend we already have a complex SimpleXML object stored in $xml
$json = json_encode(new SimpleXMLElement($xml->asXML(), LIBXML_NOCDATA));
?>
Are you sure you want to use JSON_NUMERIC_CHECK, really really sure?
Just watch this usecase:
<?php
// International phone number
json_encode(array('phone_number' => '+33123456789'), JSON_NUMERIC_CHECK);
?>
And then you get this JSON:
{"phone_number":33123456789}
Maybe it makes sense for PHP (as is_numeric('+33123456789') returns true), but really, casting it as an int?!
So be careful when using JSON_NUMERIC_CHECK, it may mess up with your data!
Attention when passing a plain array to json_encode and using JSON_FORCE_OBJECT. It figured out that the index-order of the resulting JSON-string depends on the system PHP is running on.
$a = array("a" , "b", "c");
echo json_encode($a, JSON_FORCE_OBJECT);
On Xampp (Windows) you get:
{"0":"a","1":"b","2":"c"}';
On a machine running debian I get:
{"2":"a","1":"b","0":"c"}';
Note that the key:value pairs are different!
Solution here was to use array_combine to create a ssociative array and then pass it to json_encode:
json_encode(array_combine(range(0, count($a) - 1), $a), JSON_FORCE_OBJECT);
Solution for UTF-8 Special Chars.
<?
$array = array('nome'=>'Paição','cidade'=>'São Paulo');
$array = array_map('htmlentities',$array);
//encode
$json = html_entity_decode(json_encode($array));
//Output: {"nome":"Paição","cidade":"São Paulo"}
echo $json;
?>
If you need pretty-printed output, but want it indented by 2 spaces instead of 4:
$json_indented_by_4 = json_encode($output, JSON_UNESCAPED_SLASHES|JSON_PRETTY_PRINT);
$json_indented_by_2 = preg_replace('/^( +?)\\1(?=[^ ])/m', '$1', $json_indented_by_4);
Notice that JSON_FORCE_OBJECT will convert all non-associative arrays to objects. This is not necessarily a good solution for empty arrays.
If you want to convert only empty arrays to objects, simply convert them to empty object before use json_encode function.
For example:
<?php
$foo=array(
'empty2object'=>(object)[],
'empty2array'=>[],
);
echo json_encode($foo); // {"empty2object":{},"empty2array":[]}
?>
The Problem:
---------------
When you filter an array in PHP using array_filter, the original keys are preserved. If you remove elements, you'll end up with gaps in the keys (non-consecutive). When encoded to JSON, this can lead to the list being interpreted as a JSON object instead of a JSON array, which might not be what your JavaScript code expects.
The Solution:
---------------
The array_values() function is essential in this scenario. It re-indexes the array with consecutive numerical keys (0, 1, 2, ...), ensuring that the JSON output is always a well-formed array.
Example:
----------
<?php
// Use Case: Filtering a list and ensuring consistent JSON array output
// Imagine you have a list of items and need to send a filtered version to a JavaScript frontend
// using JSON. You want to ensure the filtered list is always received as a JSON array,
// regardless of which items were removed.
// Sample data: A list of items
$items = [
"first",
"second",
"third",
"fourth",
"fifth"
];
// Items to remove from the list
$itemsToRemove = ["second", "fourth"];
// Filter the list, keeping original keys (which become non-consecutive)
$filteredItems = array_filter($items, function($item) use ($itemsToRemove) {
return !in_array($item, $itemsToRemove);
});
// Prepare data for JSON output
$output_arr = [
"list" => $filteredItems
];
// Output 1: JSON with non-consecutive keys (becomes an object)
echo "Output without array_values:\n";
echo json_encode($output_arr, JSON_PRETTY_PRINT) . "\n\n";
/* Output:
{
"list": {
"0": "first",
"2": "third",
"4": "fifth"
}
}
*/
// Reset keys to be consecutive using array_values
$output_arr['list'] = array_values($output_arr['list']);
// Output 2: JSON with consecutive keys (remains an array)
echo "Output with array_values:\n";
echo json_encode($output_arr, JSON_PRETTY_PRINT) . "\n";
/* Output:
{
"list": [
"first",
"third",
"fifth"
]
}
*/
?>