wp_filter_pre_oembed_result( null|string $result, string $url, array $args ): null|string
- Since
- 4.5.3
- Source
wp-includes/embed.php:1284
Description
If the URL belongs to the current site, the result is fetched directly instead of going through the oEmbed discovery process.
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
- Scaling
- Constant
- Instructions
- 10–16
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.4, depending on the branch taken. The body compiles to 17.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_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.4.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10 | get_oembed_response_data_for_url() |
| always | 16 | get_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 and 8.4: 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
- 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.
- _wp_oembed_get_object()::data2html()
Source code
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.
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.