WP_REST_Server::get_target_hints_for_link( array $link ): array|null

Compatibility

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

Parameters

$linkarray

The link to get target hints for.

Return value

array|null

Performance profile

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

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

Plugin surface

None

Nothing here hands control to plugin code.

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()one call below WP_REST_Server::get_target_hints_for_link()

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_Server::get_target_hints_for_link() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• rest_get_server()Retrieves the current REST server instance.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• rest_send_allow_header()Sends the "Allow" header to state all methods that can be sent to the current route.
• WP_REST_Request::from_url()Retrieves a WP_REST_Request object from a full URL.
• WP_REST_Response::__construct()
• rest_send_allow_header($response, $server, $request)::get_headers()
• WP_REST_Request::canonicalize_header_name()Canonicalizes the header name.

Used by · 1

• WP_REST_Server::get_response_links()Retrieves links from a response.

Source code

View on Trac ↗View on GitHub ↗

666	protected static function get_target_hints_for_link( $link ) {667		// Prefer targetHints that were specifically designated by the developer.668		if ( isset( $link['targetHints']['allow'] ) ) {669			return null;670		}671 672		$request = WP_REST_Request::from_url( $link['href'] );673		if ( ! $request ) {674			return null;675		}676 677		$server = rest_get_server();678		$match  = $server->match_request_to_handler( $request );679 680		if ( is_wp_error( $match ) ) {681			return null;682		}683 684		if ( is_wp_error( $request->has_valid_params() ) ) {685			return null;686		}687 688		if ( is_wp_error( $request->sanitize_params() ) ) {689			return null;690		}691 692		$target_hints = array();693 694		$response = new WP_REST_Response();695		$response->set_matched_route( $match[0] );696		$response->set_matched_handler( $match[1] );697		$headers = rest_send_allow_header( $response, $server, $request )->get_headers();698 699		foreach ( $headers as $name => $value ) {700			$name = WP_REST_Request::canonicalize_header_name( $name );701 702			$target_hints[ $name ] = array_map( 'trim', explode( ',', $value ) );703		}704 705		return $target_hints;706	}

Changelog

Introduced in 6.7.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.