WP_oEmbed::get_html( string $url, array|string $args = '' )
The do-it-all function that takes a URL and attempts to return the HTML.
Description
See also
Parameters
- $url
-
(Required) The URL to the content that should be attempted to be embedded.
- $args
-
(Optional) Arguments, usually passed from a shortcode.
Default value: ''
Return
(false|string) False on failure, otherwise the UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
Source
File: wp-includes/class-oembed.php
public function get_html( $url, $args = '' ) {
/**
* Filters the oEmbed result before any HTTP requests are made.
*
* This allows one to short-circuit the default logic, perhaps by
* replacing it with a routine that is more optimal for your setup.
*
* Passing a non-null value to the filter will effectively short-circuit retrieval,
* returning the passed value instead.
*
* @since WP-4.5.3
*
* @param null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. Default null.
* @param string $url The URL to the content that should be attempted to be embedded.
* @param array $args Optional. Arguments, usually passed from a shortcode. Default empty.
*/
$pre = apply_filters( 'pre_oembed_result', null, $url, $args );
if ( null !== $pre ) {
return $pre;
}
$data = $this->get_data( $url, $args );
if ( false === $data ) {
return false;
}
/**
* Filters the HTML returned by the oEmbed provider.
*
* @since WP-2.9.0
*
* @param string $data The returned oEmbed HTML.
* @param string $url URL of the content to be embedded.
* @param array $args Optional arguments, usually passed from a shortcode.
*/
return apply_filters( 'oembed_result', $this->data2html( $data, $url ), $url, $args );
}
Changelog
Version | Description |
---|---|
WP-2.9.0 | Introduced. |