get_oembed_response_data_for_url( string $url, array $args ): object|false

Compatibility

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

Parameters

$urlstring

The URL that should be inspected for discovery <link> tags.

$argsarray

oEmbed remote get arguments.

Return value

object|false

oEmbed response data if the URL does belong to the current site. False otherwise.

Performance profile

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

19–103

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

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

2

2 places 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
• cacheobject cachewp_cache_switch_to_blog()one call below get_oembed_response_data_for_url()
• optionoption read or writeget_option()one call below get_oembed_response_data_for_url()
• querycontent queryget_post()one call below get_oembed_response_data_for_url()

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

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( oembed_request_post_id )filterline 687 (+46 into the body)

   Filters the determined post ID.

Uses · 12

• is_multisite()Determines whether Multisite is enabled.
• wp_parse_args()Merges user defined arguments into defaults array.
• wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.
• is_subdomain_install()Whether a subdomain configuration is enabled.
• get_network()Retrieves network data given a network ID or network object.
• get_sites()Retrieves a list of sites matching requested arguments.
• get_current_blog_id()Retrieves the current site ID.
• switch_to_blog()Switches the current blog.
• 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.
• restore_current_blog()Restores the current blog, after calling switch_to_blog().
• get_oembed_response_data()Retrieves the oEmbed response data for a given post.

Used by · 2

• WP_oEmbed_Controller::get_proxy_item()Callback for the proxy API endpoint.
• wp_filter_pre_oembed_result()Filters the oEmbed result before any HTTP requests are made.

Source code

View on Trac ↗View on GitHub ↗

641function get_oembed_response_data_for_url( $url, $args ) {642	$switched_blog = false;643 644	if ( is_multisite() ) {645		$url_parts = wp_parse_args(646			wp_parse_url( $url ),647			array(648				'host' => '',649				'port' => null,650				'path' => '/',651			)652		);653 654		$qv = array(655			'domain'                 => $url_parts['host'] . ( $url_parts['port'] ? ':' . $url_parts['port'] : '' ),656			'path'                   => '/',657			'update_site_meta_cache' => false,658		);659 660		// In case of subdirectory configs, set the path.661		if ( ! is_subdomain_install() ) {662			$path = explode( '/', ltrim( $url_parts['path'], '/' ) );663			$path = reset( $path );664 665			if ( $path ) {666				$qv['path'] = get_network()->path . $path . '/';667			}668		}669 670		$sites = get_sites( $qv );671		$site  = reset( $sites );672 673		// Do not allow embeds for deleted/archived/spam sites.674		if ( ! empty( $site->deleted ) || ! empty( $site->spam ) || ! empty( $site->archived ) ) {675			return false;676		}677 678		if ( $site && get_current_blog_id() !== (int) $site->blog_id ) {679			switch_to_blog( $site->blog_id );680			$switched_blog = true;681		}682	}683 684	$post_id = url_to_postid( $url );685 686	/** This filter is documented in wp-includes/class-wp-oembed-controller.php */687	$post_id = apply_filters( 'oembed_request_post_id', $post_id, $url );688 689	if ( ! $post_id ) {690		if ( $switched_blog ) {691			restore_current_blog();692		}693 694		return false;695	}696 697	$width = $args['width'] ?? 0;698 699	$data = get_oembed_response_data( $post_id, $width );700 701	if ( $switched_blog ) {702		restore_current_blog();703	}704 705	return $data ? (object) $data : false;706}

Changelog

Introduced in 5.0.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/embed.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.