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

Description

Parameters

$associativebool|nulloptional

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. Defaults to true (in contrast to the PHP native default of null).Default: true

$depthintoptional

Maximum nesting depth of the structure being decoded. Defaults to 512.Default: 512

$optionsintoptional

Bitmask of JSON_BIGINT_AS_STRING, JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE, JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR. Defaults to 0 (no options set).Default: 0

Return

array

Uses · 1

• \WpOrg\Requests\Exception::__construct()

Source

View on Trac ↗View on GitHub ↗

155	public function decode_body($associative = true, $depth = 512, $options = 0) {156		$data = json_decode($this->body, $associative, $depth, $options);157 158		if (json_last_error() !== JSON_ERROR_NONE) {159			$last_error = json_last_error_msg();160			throw new Exception('Unable to parse JSON data: ' . $last_error, 'response.invalid', $this);161		}162 163		return $data;164	}

History

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/Requests/src/Response.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.