WP_REST_Server::response_to_data( WP_REST_Response $response, bool|string[] $embed ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$responseWP_REST_Response

Response object.

$embedbool|string[]

Whether to embed all links, a filtered list of link relations, or no links.

Return value

array

Data with sub-requests embedded.

• $_linksarray

  Links.

• $_embeddedarray

  Embedded objects.

Performance profile

How much work a call to WP_REST_Server::response_to_data() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

13–28

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 40.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Server::response_to_data() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• wp_is_numeric_array()Determines if the variable is a numeric-indexed array.
• WP_REST_Server::get_compact_response_links()Retrieves the CURIEs (compact URIs) used for relations.
• WP_REST_Server::embed_links()Embeds the links from the data into the request.

Used by · 3

• WP_REST_Server::embed_links()Embeds the links from the data into the request.
• WP_REST_Server::envelope_response()Wraps the response in an envelope.
• WP_REST_Server::serve_request()Handles serving a REST API request.

Source code

View on Trac ↗View on GitHub ↗

589	public function response_to_data( $response, $embed ) {590		$data  = $response->get_data();591		$links = self::get_compact_response_links( $response );592 593		if ( ! empty( $links ) ) {594			// Convert links to part of the data.595			$data['_links'] = $links;596		}597 598		if ( $embed ) {599			$this->embed_cache = array();600			// Determine if this is a numeric array.601			if ( wp_is_numeric_array( $data ) ) {602				foreach ( $data as $key => $item ) {603					$data[ $key ] = $this->embed_links( $item, $embed );604				}605			} else {606				$data = $this->embed_links( $data, $embed );607			}608			$this->embed_cache = array();609		}610 611		return $data;612	}

Changelog

Introduced in 4.4.0. 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 7.0.4 tag, from src/wp-includes/rest-api/class-wp-rest-server.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.