WP_REST_Server::embed_links( array $data, bool|string[] $embed = true ): 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

$dataarray

Data from the request.

$embedbool|string[]optional

Whether to embed all links or a filtered list of link relations.
Default true.Default: true

Return value

array

Data with sub-requests embedded.

• $_linksarray

  Links.

• $_embeddedarray

  Embedded objects.

Performance profile

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

5–14

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

Plugin surface

1 hook

Third-party callbacks on 'rest_post_dispatch' run inside this call, and their cost is not bounded by anything here.

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

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

Hooks and filters fired · 1

One hook fires while WP_REST_Server::embed_links() runs, in this order:

1. 1
   apply_filters( rest_post_dispatch )filterline 824 (+49 into the body)

   Filters the REST API response.

Uses · 7

• is_wp_error()Checks whether the given variable is a WordPress Error.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Request::from_url()Retrieves a WP_REST_Request object from a full URL.
• WP_REST_Server::match_request_to_handler()Matches a request object to its handler.
• WP_REST_Server::dispatch()Matches the request to a callback and call it.
• WP_REST_Server::response_to_data()Converts a response to data to send.

Used by · 1

• WP_REST_Server::response_to_data()Converts a response to data to send.

Source code

View on Trac ↗View on GitHub ↗

775	protected function embed_links( $data, $embed = true ) {776		if ( empty( $data['_links'] ) ) {777			return $data;778		}779 780		$embedded = array();781 782		foreach ( $data['_links'] as $rel => $links ) {783			/*784			 * If a list of relations was specified, and the link relation785			 * is not in the list of allowed relations, don't process the link.786			 */787			if ( is_array( $embed ) && ! in_array( $rel, $embed, true ) ) {788				continue;789			}790 791			$embeds = array();792 793			foreach ( $links as $item ) {794				// Determine if the link is embeddable.795				if ( empty( $item['embeddable'] ) ) {796					// Ensure we keep the same order.797					$embeds[] = array();798					continue;799				}800 801				if ( ! array_key_exists( $item['href'], $this->embed_cache ) ) {802					// Run through our internal routing and serve.803					$request = WP_REST_Request::from_url( $item['href'] );804					if ( ! $request ) {805						$embeds[] = array();806						continue;807					}808 809					// Embedded resources get passed context=embed.810					if ( empty( $request['context'] ) ) {811						$request['context'] = 'embed';812					}813 814					if ( empty( $request['per_page'] ) ) {815						$matched = $this->match_request_to_handler( $request );816						if ( ! is_wp_error( $matched ) && isset( $matched[1]['args']['per_page']['maximum'] ) ) {817							$request['per_page'] = (int) $matched[1]['args']['per_page']['maximum'];818						}819					}820 821					$response = $this->dispatch( $request );822 823					/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */824					$response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $this, $request );825 826					$this->embed_cache[ $item['href'] ] = $this->response_to_data( $response, false );827				}828 829				$embeds[] = $this->embed_cache[ $item['href'] ];830			}831 832			// Determine if any real links were found.833			$has_links = count( array_filter( $embeds ) );834 835			if ( $has_links ) {836				$embedded[ $rel ] = $embeds;837			}838		}839 840		if ( ! empty( $embedded ) ) {841			$data['_embedded'] = $embedded;842		}843 844		return $data;845	}

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.1.0 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.