WP_oEmbed_Controller::get_proxy_item( WP_REST_Request $request ): object|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

object|WP_Error

oEmbed response data or WP_Error on failure.

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

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

Instructions

21–76

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

Plugin surface

2 hooks

Third-party callbacks on 'oembed_result', 'rest_oembed_ttl' 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

• transienttransientget_transient()called directly
• hookthird-party callbacksapply_filters()called directly
• serializeserialisationserialize()called directly
• cacheobject cachewp_cache_get()one call below WP_oEmbed_Controller::get_proxy_item()
• optionoption read or writeget_option()one call below WP_oEmbed_Controller::get_proxy_item()

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 5 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_oEmbed_Controller::get_proxy_item() runs, in this order:

1. 1
   apply_filters( oembed_result )filterline 226 (+57 into the body)

   Filters the HTML returned by the oEmbed provider.

2. 2
   apply_filters( rest_oembed_ttl )filterline 240 (+71 into the body)

   Filters the oEmbed TTL value (time to live).

Uses · 10

• get_transient()Retrieves the value of a transient.
• get_oembed_response_data_for_url()Retrieves the oEmbed response data for a given URL.
• _wp_oembed_get_object()Returns the initialized WP_oEmbed object.
• __()Retrieves the translation of $text.
• get_status_header_desc()Retrieves the description for the HTTP status.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• set_transient()Sets/updates the value of a transient.
• _wp_oembed_get_object()::get_data()
• WP_Error::__construct()Initializes the error.
• _wp_oembed_get_object()::data2html()

Source code

View on Trac ↗View on GitHub ↗

169	public function get_proxy_item( $request ) {170		global $wp_embed, $wp_scripts;171 172		$args = $request->get_params();173 174		// Serve oEmbed data from cache if set.175		unset( $args['_wpnonce'] );176		$cache_key = 'oembed_' . md5( serialize( $args ) );177		$data      = get_transient( $cache_key );178		if ( ! empty( $data ) ) {179			return $data;180		}181 182		$url = $request['url'];183		unset( $args['url'] );184 185		// Copy maxwidth/maxheight to width/height since WP_oEmbed::fetch() uses these arg names.186		if ( isset( $args['maxwidth'] ) ) {187			$args['width'] = $args['maxwidth'];188		}189		if ( isset( $args['maxheight'] ) ) {190			$args['height'] = $args['maxheight'];191		}192 193		// Short-circuit process for URLs belonging to the current site.194		$data = get_oembed_response_data_for_url( $url, $args );195 196		if ( $data ) {197			return $data;198		}199 200		$data = _wp_oembed_get_object()->get_data( $url, $args );201 202		if ( false === $data ) {203			// Try using a classic embed, instead.204			/* @var WP_Embed $wp_embed */205			$html = $wp_embed->get_embed_handler_html( $args, $url );206 207			if ( $html ) {208				// Check if any scripts were enqueued by the shortcode, and include them in the response.209				$enqueued_scripts = array();210 211				foreach ( $wp_scripts->queue as $script ) {212					$enqueued_scripts[] = $wp_scripts->registered[ $script ]->src;213				}214 215				return (object) array(216					'provider_name' => __( 'Embed Handler' ),217					'html'          => $html,218					'scripts'       => $enqueued_scripts,219				);220			}221 222			return new WP_Error( 'oembed_invalid_url', get_status_header_desc( 404 ), array( 'status' => 404 ) );223		}224 225		/** This filter is documented in wp-includes/class-wp-oembed.php */226		$data->html = apply_filters( 'oembed_result', _wp_oembed_get_object()->data2html( (object) $data, $url ), $url, $args );227 228		/**229		 * Filters the oEmbed TTL value (time to live).230		 *231		 * Similar to the {@see 'oembed_ttl'} filter, but for the REST API232		 * oEmbed proxy endpoint.233		 *234		 * @since 4.8.0235		 *236		 * @param int    $time    Time to live (in seconds).237		 * @param string $url     The attempted embed URL.238		 * @param array  $args    An array of embed request arguments.239		 */240		$ttl = apply_filters( 'rest_oembed_ttl', DAY_IN_SECONDS, $url, $args );241 242		set_transient( $cache_key, $data, $ttl );243 244		return $data;245	}

Changelog

Introduced in 4.8.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.8.8 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.