json

Summary

The json option is used to easily upload JSON encoded data as the body of a request. A Content-Type header of application/json will be added if no Content-Type header is already present on the message.

Types

Any PHP type that can be operated on by PHP’s json_encode() function.

Default

None

Constant

GuzzleHttp\RequestOptions::JSON

1. $response = $client->request('PUT', '/put', ['json' => ['foo' => 'bar']]);

Here’s an example of using the tap middleware to see what request is sent over the wire.

1. use GuzzleHttp\Middleware;

3. // Create a middleware that echoes parts of the request.
4. $tapMiddleware = Middleware::tap(function ($request) {
5. echo $request->getHeaderLine('Content-Type');
6. // application/json
7. echo $request->getBody();
8. // {"foo":"bar"}
9. });

11. // The $handler variable is the handler passed in the
12. // options to the client constructor.
13. $response = $client->request('PUT', '/put', [
14. 'json'    => ['foo' => 'bar'],
15. 'handler' => $tapMiddleware($handler)
16. ]);

Note

This request option does not support customizing the Content-Type header or any of the options from PHP’s json_encode() function. If you need to customize these settings, then you must pass the JSON encoded data into the request yourself using the body request option and you must specify the correct Content-Type header using the headers request option.

This option cannot be used with body, form_params, or multipart