WP_oEmbed_Controller::get_item( WP_REST_Request $request ): array|WP_Error

Description

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 data about the request.

Return value

array|WP_Error

oEmbed response data or WP_Error on failure.

Performance profile

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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

24–32

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

Plugin surface

1 hook

Third-party callbacks on 'oembed_request_post_id' 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
• optionoption read or writeget_option()one call below WP_oEmbed_Controller::get_item()
• querycontent queryget_post()one call below WP_oEmbed_Controller::get_item()

Further down the call graph this can also reach 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 · 2 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_oEmbed_Controller::get_item() runs, in this order:

1. 1
   apply_filters( oembed_request_post_id )filterline 130 (+11 into the body)

   Filters the determined post ID.

Uses · 5

• url_to_postid()Examines a URL and try to determine the post ID it represents.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_oembed_response_data()Retrieves the oEmbed response data for a given post.
• get_status_header_desc()Retrieves the description for the HTTP status.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

119	public function get_item( $request ) {120		$post_id = url_to_postid( $request['url'] );121 122		/**123		 * Filters the determined post ID.124		 *125		 * @since 4.4.0126		 *127		 * @param int    $post_id The post ID.128		 * @param string $url     The requested URL.129		 */130		$post_id = apply_filters( 'oembed_request_post_id', $post_id, $request['url'] );131 132		$data = get_oembed_response_data( $post_id, $request['maxwidth'] );133 134		if ( ! $data ) {135			return new WP_Error( 'oembed_invalid_url', get_status_header_desc( 404 ), array( 'status' => 404 ) );136		}137 138		return $data;139	}

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 6.7.7 tag, from src/wp-includes/class-wp-oembed-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.