PHP json_encode() - Encode to JSON String

Learn PHP json_encode() function. Convert a PHP variable to a JSON string for API responses and data exchange.

Introduction

The json_encode() function in PHP is an essential tool when working with JSON data. It converts PHP arrays and objects into JSON-formatted strings, making it ideal for REST APIs, configuration files, data storage, and client-server communication. JSON (JavaScript Object Notation) is a lightweight data interchange format widely used for transmitting data between a server and web application.

This tutorial explains how to use json_encode() effectively, complete with setup instructions, detailed examples, best practices, common mistakes, and interview questions specifically related to JSON encoding in PHP.

Prerequisites

• Basic understanding of PHP syntax and variables
• Installed PHP (version 5.2.0 or higher) — json_encode() is available natively since PHP 5.2.0
• Basic knowledge of JSON format (key-value pairs, arrays, objects)
• A working web server or local development environment (e.g., XAMPP, WAMP, MAMP, or PHP CLI)

Setup Steps

1. Ensure PHP is installed: Run php -v in your terminal or command prompt to confirm.
2. Create a PHP file in your project directory to test json_encode().
3. Use your favorite IDE or text editor to write PHP code utilizing json_encode().
4. Run your PHP script via web browser or command line to see JSON output.

PHP json_encode() Explained with Examples

Basic Usage

Convert a simple PHP array to a JSON string:

<?php
$data = ['name' => 'Alice', 'age' => 25, 'city' => 'New York'];
$json = json_encode($data);
echo $json;
?>

Output:

{"name":"Alice","age":25,"city":"New York"}

Encoding Multidimensional Arrays

<?php
$users = [
    ['name' => 'Bob', 'age' => 30],
    ['name' => 'Carol', 'age' => 22]
];
echo json_encode($users);
?>

Output:

[{"name":"Bob","age":30},{"name":"Carol","age":22}]

Encoding PHP Objects

<?php
class Product {
    public $id;
    public $name;
    public function __construct($id, $name) {
        $this->id = $id;
        $this->name = $name;
    }
}

$product = new Product(1, 'Laptop');
echo json_encode($product);
?>

Output:

{"id":1,"name":"Laptop"}

Using JSON_PRETTY_PRINT for Readability

Add the JSON_PRETTY_PRINT flag to format the JSON output nicely:

<?php
$data = ['name' => 'Alice', 'age' => 25, 'city' => 'New York'];
echo json_encode($data, JSON_PRETTY_PRINT);
?>

Output:

{
    "name": "Alice",
    "age": 25,
    "city": "New York"
}

Handling UTF-8 Encoding

By default, json_encode() will escape multibyte Unicode characters. Use JSON_UNESCAPED_UNICODE to prevent escaping:

<?php
$data = ['message' => 'Привет мир']; // "Hello world" in Russian
echo json_encode($data, JSON_UNESCAPED_UNICODE);
?>

Output:

{"message":"Привет мир"}

Best Practices for Using json_encode()

• Validate your data: Ensure PHP arrays or objects are well-formed and do not contain resources or closures that json_encode() cannot process.
• Use appropriate flags: For human-readable output, use JSON_PRETTY_PRINT. For UTF-8 content, use JSON_UNESCAPED_UNICODE.
• Check for errors: After encoding, check if json_last_error() returns JSON_ERROR_NONE to detect encoding errors.
• Use in APIs: When returning JSON in API responses, set the header Content-Type: application/json.
• Avoid circular references: Objects referencing themselves can cause encoding to fail or return empty values.

Common Mistakes to Avoid

• Encoding PHP resources or closures — json_encode() only supports scalars, arrays, objects, null.
• Not handling false return values — if encoding fails, the function returns false silently.
• Passing malformed UTF-8 strings — can cause encoding to fail or omit those characters.
• Assuming encoded objects will maintain private or protected properties — only public properties are encoded.
• Ignoring json_last_error_msg() after encoding to troubleshoot unexpected errors.

Interview Questions About PHP json_encode()

Junior Level Questions

• Q1: What does the PHP json_encode() function do?
  A1: It converts a PHP variable like an array or object into a JSON-formatted string.
• Q2: Which data types can json_encode() serialize?
  A2: Arrays, objects, strings, numbers, booleans, and null.
• Q3: How do you make the JSON output more readable when using json_encode()?
  A3: Add the JSON_PRETTY_PRINT option as the second argument.
• Q4: How do you convert this PHP array ['apple', 'banana'] to JSON?
  A4: Using json_encode(['apple', 'banana']).
• Q5: Can json_encode() encode PHP resources or closures?
  A5: No, resources and closures cannot be encoded with json_encode().

Mid Level Questions

• Q1: What will json_encode() output when encoding a PHP object with private properties?
  A1: Only public properties are included in the JSON output.
• Q2: How can you prevent Unicode characters from being escaped when encoding JSON?
  A2: Use the JSON_UNESCAPED_UNICODE flag.
• Q3: How do you detect if json_encode() failed during encoding?
  A3: Check if the function returns false and call json_last_error().
• Q4: What kind of data can cause json_encode() to return false?
  A4: Data containing unsupported types like resources, circular references, or malformed UTF-8 strings.
• Q5: How do you set the HTTP header to correctly serve JSON data?
  A5: Use header('Content-Type: application/json');.

Senior Level Questions

• Q1: How does json_encode() handle PHP associative arrays versus indexed arrays?
  A1: Associative arrays are encoded as JSON objects; indexed arrays are encoded as JSON arrays.
• Q2: Explain how you would customize JSON serialization of a PHP object with the JsonSerializable interface.
  A2: Implement the JsonSerializable interface's jsonSerialize() method to return data that should be serialized.
• Q3: What are the implications of encoding large datasets with json_encode() in terms of performance?
  A3: Encoding very large arrays or objects can be memory-intensive and slow, so consider streaming JSON or pagination.
• Q4: How can encoding circular references in PHP objects be avoided or handled?
  A4: Avoid circular references or implement custom serialization via JsonSerializable or unset recursive links before encoding.
• Q5: Describe a scenario where you would combine multiple JSON encoding options.
  A5: When creating API responses, you might combine JSON_PRETTY_PRINT, JSON_UNESCAPED_SLASHES, and JSON_UNESCAPED_UNICODE for readability and clean data.

Frequently Asked Questions (FAQ)

• Q: What PHP version introduced json_encode()?
  A: PHP 5.2.0 and above include the json_encode() function natively.
• Q: Can json_encode() encode resources like database connections?
  A: No, resources such as database connections or file handles cannot be encoded.
• Q: How do you handle encoding errors with json_encode()?
  A: Check the return value for false and then use json_last_error() or json_last_error_msg() for specifics.
• Q: Does json_encode() encode private and protected object properties?
  A: No, only public properties are encoded by default.
• Q: How can I make JSON output human-readable?
  A: Pass the JSON_PRETTY_PRINT flag as the second argument.

Conclusion

The PHP json_encode() function is a powerful and straightforward way to convert PHP data structures like arrays and objects into JSON strings. This functionality is critical when building REST APIs, performing data interchange, or storing structured data. By understanding its usage, flags, common pitfalls, and error handling, you can efficiently output JSON data that is easy to use and maintain.

Always validate your data, check encoding errors, and adhere to best practices to ensure your JSON output is reliable and compatible with consuming applications.