WP_oEmbed::get_html() WordPress Method
The WP_oEmbed::get_html() method is used to retrieve the HTML for an embeddable resource.
WP_oEmbed::get_html( string $url, string|array $args = '' ) #
The do-it-all function that takes a URL and attempts to return the HTML.
Description
See also
Parameters
- $url
(string)(Required)The URL to the content that should be attempted to be embedded.
- $args
(string|array)(Optional) Additional arguments for retrieving embed HTML. See wp_oembed_get() for accepted arguments.
Default value: ''
Return
(string|false) The UNSANITIZED (and potentially unsafe) HTML that should be used to embed on success, false on failure.
Source
File: wp-includes/class-wp-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.
*
* Returning a non-null value from the filter will effectively short-circuit retrieval
* and return the passed value instead.
*
* @since 4.5.3
*
* @param null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
* Default null to continue retrieving the result.
* @param string $url The URL to the content that should be attempted to be embedded.
* @param string|array $args Optional. Additional arguments for retrieving embed HTML.
* See wp_oembed_get() for accepted arguments. 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 2.9.0
*
* @param string|false $data The returned oEmbed HTML (false if unsafe).
* @param string $url URL of the content to be embedded.
* @param string|array $args Optional. Additional arguments for retrieving embed HTML.
* See wp_oembed_get() for accepted arguments. Default empty.
*/
return apply_filters( 'oembed_result', $this->data2html( $data, $url ), $url, $args );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |