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

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

string|false

The embed HTML on success, false on failure.

Uses · 1

• _wp_oembed_get_object()Returns the initialized WP_oEmbed object.

Used by · 2

• WP_Embed::shortcode()The do_shortcode() callback function.
• WP_Widget_Media_Video::render_media()Render the media on the frontend.

Source

View on Trac ↗View on GitHub ↗

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

History

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 6.8.8 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.