Response::decode_body( bool|null $associative = true, int $depth = 512, int $options )

JSON decode the response body.

Description

The method parameters are the same as those for the PHP native json_decode() function.

Parameters

$associative

(Optional) When true, JSON objects will be returned as associative arrays; When false, JSON objects will be returned as objects.<br> When null, JSON objects will be returned as associative arrays or objects depending on whether JSON_OBJECT_AS_ARRAY is set in the flags.<br> Defaults to true (in contrast to the PHP native default of null).

Default value: true

$depth

(Optional) Maximum nesting depth of the structure being decoded.<br> Defaults to 512.

Default value: 512

$options

(Optional) Bitmask of JSON_BIGINT_AS_STRING, JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE, JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR.<br> Defaults to 0 (no options set).

Return

(array)

Source

File: wp-includes/Requests/src/Response.php

	public function decode_body($associative = true, $depth = 512, $options = 0) {
		$data = json_decode($this->body, $associative, $depth, $options);

		if (json_last_error() !== JSON_ERROR_NONE) {
			$last_error = json_last_error_msg();
			throw new Exception('Unable to parse JSON data: ' . $last_error, 'response.invalid', $this);
		}

		return $data;
	}

Expand Source Code View on GitHub