wppaste
WordPress

wp_filter_pre_oembed_result( null|string $result, string $url, array $args ): null|string

Since
4.5.3
Source
wp-includes/embed.php:1284
Filters the oEmbed result before any HTTP requests are made.

Description

If the URL belongs to the current site, the result is fetched directly instead of going through the oEmbed discovery process.

Compatibility

WordPress
since 4.5.3
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$resultnull|string
The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. Default null.
$urlstring
The URL that should be inspected for discovery <link> tags.
$argsarray
oEmbed remote get arguments.

Return value

null|string
The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
Null if the URL does not belong to the current site.

Performance profile

How much work a call to wp_filter_pre_oembed_result() 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
10–16

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

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

What it touches

  • hookthird-party callbacksapply_filters()one call below wp_filter_pre_oembed_result()

Further down the call graph this can also reach cache, option, query, 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_filter_pre_oembed_result() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always10get_oembed_response_data_for_url()
always16get_oembed_response_data_for_url(), _wp_oembed_get_object(), ->data2html()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 17 instructions, 10–16 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 3

Source code

View on Trac View on GitHub 

function wp_filter_pre_oembed_result( $result, $url, $args ) {	$data = get_oembed_response_data_for_url( $url, $args ); 	if ( $data ) {		return _wp_oembed_get_object()->data2html( $data, $url );	} 	return $result;}

Changelog

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