WpOrg\Requests

Response::decode_body()publicWP 1.0

JSON decode the response body.

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

Method of the class: Response{}

No Hooks.

Return

Array.

Usage

$Response = new Response();
$Response->decode_body( $associative, $depth, $options );
$associative(true|false|null)
When true, JSON objects will be returned as associative arrays; When false, JSON objects will be returned as objects. When null, JSON objects will be returned as associative arrays or objects depending on whether JSON_OBJECT_AS_ARRAY is set in the flags.
Default: true (in contrast to the PHP native default of null)
$depth(int)
Maximum nesting depth of the structure being decoded.
Default: 512
$options(int)
Bitmask of JSON_BIGINT_AS_STRING, JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE, JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR.
Default: 0 (no options set)

Response::decode_body() code WP 6.6.2

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;
}