json_last_error

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

json_last_error — Returns the last error occurred

Description

json_last_error(): int

Returns the last error (if any) occurred during the last JSON encoding/decoding, which did not specify JSON_THROW_ON_ERROR.

Parameters

This function has no parameters.

Return Values

Returns an integer, the value can be one of the following constants:

**JSON error codes**
Constant	Meaning	Availability
`JSON_ERROR_NONE`	No error has occurred
`JSON_ERROR_DEPTH`	The maximum stack depth has been exceeded
`JSON_ERROR_STATE_MISMATCH`	Invalid or malformed JSON
`JSON_ERROR_CTRL_CHAR`	Control character error, possibly incorrectly encoded
`JSON_ERROR_SYNTAX`	Syntax error
`JSON_ERROR_UTF8`	Malformed UTF-8 characters, possibly incorrectly encoded
`JSON_ERROR_RECURSION`	One or more recursive references in the value to be encoded
`JSON_ERROR_INF_OR_NAN`	One or more `NAN` or `INF` values in the value to be encoded
`JSON_ERROR_UNSUPPORTED_TYPE`	A value of a type that cannot be encoded was given
`JSON_ERROR_INVALID_PROPERTY_NAME`	A property name that cannot be encoded was given
`JSON_ERROR_UTF16`	Malformed UTF-16 characters, possibly incorrectly encoded

Examples

Example #1 json_last_error() example


<?php
// A valid json string
$json[] = '{"Organization": "PHP Documentation Team"}';

// An invalid json string which will cause an syntax 
// error, in this case we used ' instead of " for quotation
$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;
}
?>

The above example will output:

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

Example #2 json_last_error() with json_encode()


<?php
// An invalid UTF8 sequence
$text = "\xB1\x31";

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

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

The above example will output:

string(4) "null"
bool(true)

Example #3 json_last_error() and JSON_THROW_ON_ERROR


<?php
// An invalid UTF8 sequence which causes JSON_ERROR_UTF8
json_encode("\xB1\x31");

// The following does not cause a JSON error
json_encode('okay', JSON_THROW_ON_ERROR);

// The global error state has not been changed by the former json_encode()
var_dump(json_last_error() === JSON_ERROR_UTF8);
?>

The above example will output:

bool(true)

User Contributed Notes 8 notes

down

262

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 ¶

9 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

msxcms at bmforum dot com ¶

6 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

hemono at gmail dot com ¶

8 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

George Dimitriadis ¶

7 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

jairospino at ingenieros dot com ¶

3 years ago


Esta clase de ejemplo muestra como podríamos validar si un Json tiene el formato correctamente.

<?php

class Biblioteca
{   

     // Se valida que el formato Json este correctamente     
    public function validarJson($json = 'error')
    {
        
        $retornaJson = json_decode($json);
        
        switch (json_last_error()) {
            case JSON_ERROR_NONE:
                $error = ''; 
                break;
            case JSON_ERROR_DEPTH:
                $error = 'Se superó la profundidad máxima de la pila.';
                break;
            case JSON_ERROR_STATE_MISMATCH:
                $error = 'JSON inválido o mal formado.';
                break;
            case JSON_ERROR_CTRL_CHAR:
                $error = 'Error de carácter de control, posiblemente codificado incorrectamente.';
                break;
            case JSON_ERROR_SYNTAX:
                $error = 'Error de sintaxis, JSON con formato incorrecto.';
                break;
            case JSON_ERROR_UTF8:
                $error = 'Caracteres UTF-8 con formato incorrecto, posiblemente codificados incorrectamente.';
                break;
            case JSON_ERROR_RECURSION:
                $error = 'Una o más referencias recursivas en el valor a codificar.';
                break;
            case JSON_ERROR_INF_OR_NAN:
                $error = 'Uno o más valores NaN o InF en el valor que se va a codificar.';
                break;
            case JSON_ERROR_UNSUPPORTED_TYPE:
                $error = 'Se proporcionó un valor de un tipo que no se puede codificar.';
                break;
            default:
                $error = 'Ocurrió un error JSON desconocido.';
                break;
        }

        if ($error !== '') {            
            return $error;
        }
        
        return $retornaJson;
    }
 
   /**   respuestaJson($msn, $estado, $data)
     *  -   Envía una respuesta a la solicitud realizada por el usuario 
     *  
     *      # Parámetros que recibe
     * 
     *      @msn   : indica el mensaje que el usuario tendrá como respuesta a su solicitud
     *
     *      @data  : contiene los datos de la respuesta en formato Json
     * 
     *      @estado: muestra el estado de la respuesta a la solicitud realizada por el usuario o sistema
     *               Este estado es especificado por el <<desarrollador>>
     *      
     *      Nota:  se puede reemplazar "JSON_ERROR_NONE" por "0" y funciona igual
     */
    public function respuestaJson(string $msn = 'Sin mensaje', string $estado = 'ok', string $data = null): string
    {
        // en caso que se reciban datos
        // se verifica que tengan el formato Json correcto        
        if ($data) {
            $testJson = $this->validarJson($data);            
            if (json_last_error() !== JSON_ERROR_NONE) {
                $estado = 'error';
                $msn = $testJson;
                $data = null;                
            }            
        }

        $jsonRespuesta = array(
            "estado"  => $estado,
            "mensaje" => $msn,
            "data"    => $data
        );       

        return json_encode($jsonRespuesta, JSON_UNESCAPED_UNICODE);
    }
    
}

$verMns = new Biblioteca();

echo $verMns->respuestaJson('Petición exitosa', 'ok','{"id":1122,"nombre":"Jair Ospino Ardila"}');

//Tendríamos como respuesta

{
estado: "ok",
mensaje: "Petición exitosa",
data: "{"id":1122,"nombre":"Jair Ospino Ardila"}"
}

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

json_last_error

Description

Parameters

Return Values

Examples

See Also

User Contributed Notes 8 notes