WP_REST_URL_Details_Controller::parse_url_details( WP_REST_Request $request ): WP_REST_Response|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

The parsed details as a response object. WP_Error if there are errors.

Performance profile

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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

18–76

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

Plugin surface

1 hook

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize 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 · 4 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_REST_URL_Details_Controller::parse_url_details() runs, in this order:

1. 1
   apply_filters( rest_prepare_url_details )filterline 187 (+53 into the body)

   Filters the URL data for the response.

Uses · 17

• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• __()Retrieves the translation of $text.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Error::__construct()Initializes the error.
• WP_REST_URL_Details_Controller::build_cache_key_for_url()Utility function to build cache key for a given URL.
• WP_REST_URL_Details_Controller::get_cache()Utility function to retrieve a value from the cache at a given key.
• WP_REST_URL_Details_Controller::get_remote_url()Retrieves the document title from a remote URL.
• WP_REST_URL_Details_Controller::set_cache()Utility function to cache a given data set at a given cache key.
• WP_REST_URL_Details_Controller::get_document_head()Retrieves the head element section.
• WP_REST_URL_Details_Controller::get_meta_with_content_elements()Gets all the meta tag elements that have a 'content' attribute.

Source code

View on Trac ↗View on GitHub ↗

134	public function parse_url_details( $request ) {135		$url = untrailingslashit( $request['url'] );136 137		if ( empty( $url ) ) {138			return new WP_Error( 'rest_invalid_url', __( 'Invalid URL' ), array( 'status' => 404 ) );139		}140 141		// Transient per URL.142		$cache_key = $this->build_cache_key_for_url( $url );143 144		// Attempt to retrieve cached response.145		$cached_response = $this->get_cache( $cache_key );146 147		if ( ! empty( $cached_response ) ) {148			$remote_url_response = $cached_response;149		} else {150			$remote_url_response = $this->get_remote_url( $url );151 152			// Exit if we don't have a valid body or it's empty.153			if ( is_wp_error( $remote_url_response ) || empty( $remote_url_response ) ) {154				return $remote_url_response;155			}156 157			// Cache the valid response.158			$this->set_cache( $cache_key, $remote_url_response );159		}160 161		$html_head     = $this->get_document_head( $remote_url_response );162		$meta_elements = $this->get_meta_with_content_elements( $html_head );163 164		$data = $this->add_additional_fields_to_object(165			array(166				'title'       => $this->get_title( $html_head ),167				'icon'        => $this->get_icon( $html_head, $url ),168				'description' => $this->get_description( $meta_elements ),169				'image'       => $this->get_image( $meta_elements, $url ),170			),171			$request172		);173 174		// Wrap the data in a response object.175		$response = rest_ensure_response( $data );176 177		/**178		 * Filters the URL data for the response.179		 *180		 * @since 5.9.0181		 *182		 * @param WP_REST_Response $response            The response object.183		 * @param string           $url                 The requested URL.184		 * @param WP_REST_Request  $request             Request object.185		 * @param string           $remote_url_response HTTP response body from the remote URL.186		 */187		return apply_filters( 'rest_prepare_url_details', $response, $url, $request, $remote_url_response );188	}

Changelog

Introduced in 5.9.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 6.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.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.