json_last_error

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

json_last_error — 直近に発生したエラーを返す

説明

json_last_error(): int

JSON_THROW_ON_ERROR を指定していなかった場合に、直近の JSON エンコード/デコード処理中に発生したエラー (もし存在すれば) を返します。

パラメータ

この関数にはパラメータはありません。

戻り値

整数値を返します。これは、次の定数のいずれかとなります。

**JSON error codes**
定数	意味	使用可能
`JSON_ERROR_NONE`	エラーは発生しませんでした
`JSON_ERROR_DEPTH`	スタックの深さの最大値を超えました
`JSON_ERROR_STATE_MISMATCH`	JSON の形式が無効、あるいは壊れています
`JSON_ERROR_CTRL_CHAR`	制御文字エラー。おそらくエンコーディングが違います
`JSON_ERROR_SYNTAX`	構文エラー
`JSON_ERROR_UTF8`	正しくエンコードされていないなど、不正な形式の UTF-8 文字
`JSON_ERROR_RECURSION`	エンコード対象の値に再帰参照が含まれています
`JSON_ERROR_INF_OR_NAN`	エンコード対象の値に `NAN` あるいは `INF` が含まれています。
`JSON_ERROR_UNSUPPORTED_TYPE`	エンコード不可能な型の値が渡されました
`JSON_ERROR_INVALID_PROPERTY_NAME`	エンコードできないプロパティ名が渡されました
`JSON_ERROR_UTF16`	おそらく正しくエンコードされていない、不正な UTF-16 文字

例

例1 json_last_error() の例

<?php
// 正しい json 文字列
$json[] = '{"Organization": "PHP Documentation Team"}';

// 間違った json 文字列で、構文エラーとなります
// ここでは、クォートに " ではなく ' を使用しています
$json[] = "{'Organization': 'PHP Documentation Team'}";


foreach ($json as $string) {
    echo 'Decoding: ' . $string;
    json_decode($string);

    switch (json_last_error()) {
        case JSON_ERROR_NONE:
            echo ' - No errors';
        break;
        case JSON_ERROR_DEPTH:
            echo ' - Maximum stack depth exceeded';
        break;
        case JSON_ERROR_STATE_MISMATCH:
            echo ' - Underflow or the modes mismatch';
        break;
        case JSON_ERROR_CTRL_CHAR:
            echo ' - Unexpected control character found';
        break;
        case JSON_ERROR_SYNTAX:
            echo ' - Syntax error, malformed JSON';
        break;
        case JSON_ERROR_UTF8:
            echo ' - Malformed UTF-8 characters, possibly incorrectly encoded';
        break;
        default:
            echo ' - Unknown error';
        break;
    }

    echo PHP_EOL;
}
?>

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

Decoding: {"Organization": "PHP Documentation Team"} - No errors
Decoding: {'Organization': 'PHP Documentation Team'} - Syntax error, malformed JSON

例2 json_last_error() と json_encode() の組み合わせ

<?php
// 無効な UTF8 シーケンス
$text = "\xB1\x31";

$json  = json_encode($text);
$error = json_last_error();

var_dump($json, $error === JSON_ERROR_UTF8);
?>

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

string(4) "null"
bool(true)

例3 json_last_error() と JSON_THROW_ON_ERROR の組み合わせ

<?php
// JSON_ERROR_UTF8 が発生する、不正なUTF8シーケンス
json_encode("\xB1\x31");

// 次の文字列は、JSON error が発生しない
json_encode('okay', JSON_THROW_ON_ERROR);

// グローバルなエラー状態は、直前の json_encode() によって変更されない
var_dump(json_last_error() === JSON_ERROR_UTF8);
?>

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

bool(true)

参考

json_last_error_msg() - 直近の json_encode() や json_decode() の呼び出しのエラー文字列を返す
json_decode() - JSON 文字列をデコードする
json_encode() - 値を JSON 形式にして返す

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 8 notes

down

319

jimmetry at gmail dot com ¶

12 years ago

While this can obviously change between versions, the current error codes are as follows:

0 = JSON_ERROR_NONE
1 = JSON_ERROR_DEPTH
2 = JSON_ERROR_STATE_MISMATCH
3 = JSON_ERROR_CTRL_CHAR
4 = JSON_ERROR_SYNTAX
5 = JSON_ERROR_UTF8

I'm only posting these for people who may be trying to understand why specific JSON files are not being decoded. Please do not hard-code these numbers into an error handler routine.

down

praveenscience at gmail dot com ¶

10 years ago

I used this simple script, flicked from StackOverflow to escape from the function failing:

<?php
    function utf8ize($d) {
        if (is_array($d)) {
            foreach ($d as $k => $v) {
                $d[$k] = utf8ize($v);
            }
        } else if (is_string ($d)) {
            return utf8_encode($d);
        }
        return $d;
    }
?>

Cheers,
Praveen Kumar!

down

hemono at gmail dot com ¶

9 years ago

when json_decode a empty string, PHP7 will trigger an Syntax error:
<?php
json_decode("");
var_dump(json_last_error(), json_last_error_msg());

// PHP 7
int(4)
string(12) "Syntax error"

//  PHP 5
int(0)
string(8) "No error"

down

msxcms at bmforum dot com ¶

7 years ago

use this code with mb_convert_encoding, you can json_encode some corrupt UTF-8 chars

    function safe_json_encode($value, $options = 0, $depth = 512) {
        $encoded = json_encode($value, $options, $depth);
        if ($encoded === false && $value && json_last_error() == JSON_ERROR_UTF8) {
            $encoded = json_encode(utf8ize($value), $options, $depth);
        }
        return $encoded;
    }

    function utf8ize($mixed) {
        if (is_array($mixed)) {
            foreach ($mixed as $key => $value) {
                $mixed[$key] = utf8ize($value);
            }
        } elseif (is_string($mixed)) {
            return mb_convert_encoding($mixed, "UTF-8", "UTF-8");
        }
        return $mixed;
    }

down

George Dimitriadis ¶

8 years ago

Just adding this note since I had to code this for the actual values reference.

<?php

echo JSON_ERROR_NONE . ' JSON_ERROR_NONE' . '<br />';
echo JSON_ERROR_DEPTH . ' JSON_ERROR_DEPTH' . '<br />';
echo JSON_ERROR_STATE_MISMATCH . ' JSON_ERROR_STATE_MISMATCH' . '<br />';
echo JSON_ERROR_CTRL_CHAR . ' JSON_ERROR_CTRL_CHAR' . '<br />';
echo JSON_ERROR_SYNTAX . ' JSON_ERROR_SYNTAX' . '<br />';
echo JSON_ERROR_UTF8 . ' JSON_ERROR_UTF8' . '<br />';
echo JSON_ERROR_RECURSION . ' JSON_ERROR_RECURSION' . '<br />';
echo JSON_ERROR_INF_OR_NAN . ' JSON_ERROR_INF_OR_NAN' . '<br />';
echo JSON_ERROR_UNSUPPORTED_TYPE . ' JSON_ERROR_UNSUPPORTED_TYPE' . '<br />';

/*
The above outputs :
0 JSON_ERROR_NONE
1 JSON_ERROR_DEPTH
2 JSON_ERROR_STATE_MISMATCH
3 JSON_ERROR_CTRL_CHAR
4 JSON_ERROR_SYNTAX
5 JSON_ERROR_UTF8
6 JSON_ERROR_RECURSION
7 JSON_ERROR_INF_OR_NAN
8 JSON_ERROR_UNSUPPORTED_TYPE
*/

?>

down

williamprogphp at yahoo dot com dot br ¶

10 years ago

This is a quite simple and functional trick to validate JSON's strings.

<?php

    function json_validate($string) {
        if (is_string($string)) {
            @json_decode($string);
            return (json_last_error() === JSON_ERROR_NONE);
        }
        return false;
    }
    echo (json_validate('{"test": "valid JSON"}')  ? "It's a JSON" : "NOT is a JSON"); // prints 'It's a JSON'
    echo (json_validate('{test: valid JSON}')  ? "It's a JSON" : "NOT is a JSON"); // prints 'NOT is a JSON' due to missing quotes
    echo (json_validate(array())  ? "It's a JSON" : "NOT is a JSON"); // prints 'NOT is a JSON' due to a non-string argument
?>

Cheers

down

greaties at ghvernuft dot nl ¶

1 month ago

Protected and private properties are ignored,
when json_encoding a class instance.
The snippet

<?php
class Example
{
    private   $privateprop   = "private property";
    protected $protectedprop = "protected property";
    public    $publicprop    = "public property";
}
echo json_encode(new Example);
?>

only returns 
{"publicprop":"public property"}

down

wedge at atlanteans dot net ¶

6 years ago

here is a small updated version of utf8ize that has the following addition : 
* It uses iconv instead of utf8_encode for potentially better result.
* It adds the support of objects variable 
* It also update array key value (in a case I met I had to utf8ize the key as well as those were generated from a user input value)

Here is the code.

<?php
    function utf8ize($d) {
        if (is_array($d)) {
            foreach ($d as $k => $v) {
                unset($d[$k]);
        $d[utf8ize($k)] = utf8ize($v);
            }
        } else if (is_object($d)) {
        $objVars = get_object_vars($d);
        foreach($objVars as $key => $value) {
        $d->$key = utf8ize($value);
        }        
    } else if (is_string ($d)) {
            return iconv('UTF-8', 'UTF-8//IGNORE', utf8_encode($d));
        } 
        return $d;
    }
?>

＋add a note