wppaste
WordPress

wp_oembed_get( string $url, array|string $args = '' ): string|false

Since
2.9.0
Source
wp-includes/embed.php:113
Attempts to fetch the embed HTML for a provided URL using oEmbed.

Compatibility

WordPress
since 2.9.0
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

$urlstring
The URL that should be embedded.
$argsarray|stringoptional
Additional arguments for retrieving embed HTML. Default empty.Default: ''

  • $widthint|string

    Optional. The maxwidth value passed to the provider URL.

  • $heightint|string

    Optional. The maxheight value passed to the provider URL.

  • $discoverbooldefault: true

    Optional. Determines whether to attempt to discover link tags at the given URL for an oEmbed provider when the provider URL is not found in the built-in providers list.

Return value

string|false
The embed HTML on success, false on failure.

Performance profile

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

Executed per call on PHP 8.5. The body compiles to 10.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
3

3 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always10_wp_oembed_get_object(), ->get_html()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 executed per call, 0 branches. 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 · 1

Used by · 3

Source code

View on Trac View on GitHub 

function wp_oembed_get( $url, $args = '' ) {	$oembed = _wp_oembed_get_object();	return $oembed->get_html( $url, $args );}

Changelog

Introduced in 2.9.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.0.4 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.