WP_REST_Request::parse_json_params(): true|WP_Error
- Since
- 4.4.0, 4.7.0
- Source
wp-includes/rest-api/class-wp-rest-request.php:703
Description
Avoids parsing the JSON data until we need to access it.
Compatibility
- WordPress
- since 4.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Return value
true|WP_Error- True if the JSON data was passed or no JSON data was provided, WP_Error if invalid JSON was passed.
Performance profile
How much work a call to WP_REST_Request::parse_json_params() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 3–43
- Plugin surface
- None
- Called by
- 3
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 50.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- serializeserialisation
json_decode()called directly
Further down the call graph this can also reach hook, query, option, cache and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Request::parse_json_params() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 3 | none |
!->is_json_content_type() | 8 | ->is_json_content_type() |
->is_json_content_type() && empty($body) | 13 | ->is_json_content_type(), ->get_body() |
->is_json_content_type() && !empty($body) && $params !== null | 23 | ->is_json_content_type(), ->get_body(), json_decode() |
->is_json_content_type() && !empty($body) && $params === null | 27 | ->is_json_content_type(), ->get_body(), json_decode(), json_last_error() |
->is_json_content_type() && !empty($body) && $params === null | 43 | ->is_json_content_type(), ->get_body(), json_decode(), json_last_error(), json_last_error(), json_last_error_msg(), __(), status() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 50 instructions, 3–43 executed per call, 5 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- __()Retrieves the translation of $text.
- WP_REST_Request::is_json_content_type()Checks if the request has specified a JSON Content-Type.
- WP_REST_Request::get_body()Retrieves the request body content.
- WP_Error::__construct()Initializes the error.
Used by · 3
- WP_REST_Request::get_json_params()Retrieves the parameters from a JSON-formatted body.
- WP_REST_Request::get_parameter_order()Retrieves the parameter priority order.
- WP_REST_Request::has_valid_params()Checks whether this request is valid according to its attributes.
Source code
protected function parse_json_params() { if ( $this->parsed_json ) { return true; } $this->parsed_json = true; // Check that we actually got JSON. if ( ! $this->is_json_content_type() ) { return true; } $body = $this->get_body(); if ( empty( $body ) ) { return true; } $params = json_decode( $body, true ); /* * Check for a parsing error. */ if ( null === $params && JSON_ERROR_NONE !== json_last_error() ) { // Ensure subsequent calls receive error instance. $this->parsed_json = false; $error_data = array( 'status' => WP_Http::BAD_REQUEST, 'json_error_code' => json_last_error(), 'json_error_message' => json_last_error_msg(), ); return new WP_Error( 'rest_invalid_json', __( 'Invalid JSON body passed.' ), $error_data ); } $this->params['JSON'] = $params; return true; }Changelog
Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/rest-api/class-wp-rest-request.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.