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

Attempts to fetch the embed HTML for a provided URL using oEmbed.


Description Description

See also See also


Top ↑

Parameters Parameters

$url

(string) (Required) The URL that should be embedded.

$args

(array|string) (Optional) Additional arguments for retrieving embed HTML.

  • 'width'
    (int|string) Optional. The maxwidth value passed to the provider URL.
  • 'height'
    (int|string) Optional. The maxheight value passed to the provider URL.
  • 'discover'
    (bool) 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. Default true.

Default value: ''


Top ↑

Return Return

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


Top ↑

Source Source

File: wp-includes/embed.php

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


Top ↑

Changelog Changelog

Changelog
Version Description
2.9.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.