3 * API for fetching the HTML to embed remote content based on a provided URL.
4 * Used internally by the {@link WP_Embed} class, but is designed to be generic.
6 * @link https://codex.wordpress.org/oEmbed oEmbed Codex Article
7 * @link http://oembed.com/ oEmbed Homepage
21 public $providers = array();
22 public static $early_providers = array();
24 private $compat_methods = array( '_fetch_with_format', '_parse_json', '_parse_xml', '_parse_body' );
31 public function __construct() {
33 '#http://(www\.)?youtube\.com/watch.*#i' => array( 'http://www.youtube.com/oembed', true ),
34 '#https://(www\.)?youtube\.com/watch.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ),
35 '#http://(www\.)?youtube\.com/playlist.*#i' => array( 'http://www.youtube.com/oembed', true ),
36 '#https://(www\.)?youtube\.com/playlist.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ),
37 '#http://youtu\.be/.*#i' => array( 'http://www.youtube.com/oembed', true ),
38 '#https://youtu\.be/.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ),
39 'http://blip.tv/*' => array( 'http://blip.tv/oembed/', false ),
40 '#https?://(.+\.)?vimeo\.com/.*#i' => array( 'http://vimeo.com/api/oembed.{format}', true ),
41 '#https?://(www\.)?dailymotion\.com/.*#i' => array( 'http://www.dailymotion.com/services/oembed', true ),
42 'http://dai.ly/*' => array( 'http://www.dailymotion.com/services/oembed', false ),
43 '#https?://(www\.)?flickr\.com/.*#i' => array( 'https://www.flickr.com/services/oembed/', true ),
44 '#https?://flic\.kr/.*#i' => array( 'https://www.flickr.com/services/oembed/', true ),
45 '#https?://(.+\.)?smugmug\.com/.*#i' => array( 'http://api.smugmug.com/services/oembed/', true ),
46 '#https?://(www\.)?hulu\.com/watch/.*#i' => array( 'http://www.hulu.com/api/oembed.{format}', true ),
47 'http://i*.photobucket.com/albums/*' => array( 'http://photobucket.com/oembed', false ),
48 'http://gi*.photobucket.com/groups/*' => array( 'http://photobucket.com/oembed', false ),
49 '#https?://(www\.)?scribd\.com/doc/.*#i' => array( 'http://www.scribd.com/services/oembed', true ),
50 '#https?://wordpress.tv/.*#i' => array( 'http://wordpress.tv/oembed/', true ),
51 '#https?://(.+\.)?polldaddy\.com/.*#i' => array( 'https://polldaddy.com/oembed/', true ),
52 '#https?://poll\.fm/.*#i' => array( 'https://polldaddy.com/oembed/', true ),
53 '#https?://(www\.)?funnyordie\.com/videos/.*#i' => array( 'http://www.funnyordie.com/oembed', true ),
54 '#https?://(www\.)?twitter\.com/.+?/status(es)?/.*#i' => array( 'https://api.twitter.com/1/statuses/oembed.{format}', true ),
55 '#https?://vine.co/v/.*#i' => array( 'https://vine.co/oembed.{format}', true ),
56 '#https?://(www\.)?soundcloud\.com/.*#i' => array( 'http://soundcloud.com/oembed', true ),
57 '#https?://(.+?\.)?slideshare\.net/.*#i' => array( 'https://www.slideshare.net/api/oembed/2', true ),
58 '#https?://instagr(\.am|am\.com)/p/.*#i' => array( 'https://api.instagram.com/oembed', true ),
59 '#https?://(www\.)?rdio\.com/.*#i' => array( 'http://www.rdio.com/api/oembed/', true ),
60 '#https?://rd\.io/x/.*#i' => array( 'http://www.rdio.com/api/oembed/', true ),
61 '#https?://(open|play)\.spotify\.com/.*#i' => array( 'https://embed.spotify.com/oembed/', true ),
62 '#https?://(.+\.)?imgur\.com/.*#i' => array( 'http://api.imgur.com/oembed', true ),
63 '#https?://(www\.)?meetu(\.ps|p\.com)/.*#i' => array( 'http://api.meetup.com/oembed', true ),
64 '#https?://(www\.)?issuu\.com/.+/docs/.+#i' => array( 'http://issuu.com/oembed_wp', true ),
65 '#https?://(www\.)?collegehumor\.com/video/.*#i' => array( 'http://www.collegehumor.com/oembed.{format}', true ),
66 '#https?://(www\.)?mixcloud\.com/.*#i' => array( 'http://www.mixcloud.com/oembed', true ),
67 '#https?://(www\.|embed\.)?ted\.com/talks/.*#i' => array( 'http://www.ted.com/talks/oembed.{format}', true ),
68 '#https?://(www\.)?(animoto|video214)\.com/play/.*#i' => array( 'http://animoto.com/oembeds/create', true ),
69 '#https?://(.+)\.tumblr\.com/post/.*#i' => array( 'https://www.tumblr.com/oembed/1.0', true ),
70 '#https?://(www\.)?kickstarter\.com/projects/.*#i' => array( 'https://www.kickstarter.com/services/oembed', true ),
71 '#https?://kck\.st/.*#i' => array( 'https://www.kickstarter.com/services/oembed', true ),
74 if ( ! empty( self::$early_providers['add'] ) ) {
75 foreach ( self::$early_providers['add'] as $format => $data ) {
76 $providers[ $format ] = $data;
80 if ( ! empty( self::$early_providers['remove'] ) ) {
81 foreach ( self::$early_providers['remove'] as $format ) {
82 unset( $providers[ $format ] );
86 self::$early_providers = array();
89 * Filter the list of oEmbed providers.
91 * Discovery is disabled for users lacking the unfiltered_html capability.
92 * Only providers in this array will be used for those users.
94 * Supported providers:
96 * | ------------ | -------------------- | ----- | --------- |
97 * | Provider | Flavor | SSL | Since |
98 * | ------------ | -------------------- | ----- | --------- |
99 * | Blip | blip.tv | ! | 2.9.0 |
100 * | Dailymotion | dailymotion.com | Yes | 2.9.0 |
101 * | Flickr | flickr.com | Yes | 2.9.0 |
102 * | Hulu | hulu.com | Yes | 2.9.0 |
103 * | Photobucket | photobucket.com | ! | 2.9.0 |
104 * | Scribd | scribd.com | Yes | 2.9.0 |
105 * | Vimeo | vimeo.com | Yes | 2.9.0 |
106 * | WordPress.tv | wordpress.tv | Yes | 2.9.0 |
107 * | YouTube | youtube.com/watch | Yes | 2.9.0 |
108 * | ------------ | -------------------- | ----- | --------- |
109 * | Funny or Die | funnyordie.com | Yes | 3.0.0 |
110 * | Polldaddy | polldaddy.com | Yes | 3.0.0 |
111 * | SmugMug | smugmug.com | Yes | 3.0.0 |
112 * | YouTube | youtu.be | Yes | 3.0.0 |
113 * | ------------ | -------------------- | ----- | --------- |
114 * | Twitter | twitter.com | Yes | 3.4.0 |
115 * | ------------ | -------------------- | ----- | --------- |
116 * | Instagram | instagram.com | Yes | 3.5.0 |
117 * | Instagram | instagr.am | Yes | 3.5.0 |
118 * | Slideshare | slideshare.net | Yes | 3.5.0 |
119 * | SoundCloud | soundcloud.com | Yes | 3.5.0 |
120 * | ------------ | -------------------- | ----- | --------- |
121 * | Dailymotion | dai.ly | ! | 3.6.0 |
122 * | Flickr | flic.kr | Yes | 3.6.0 |
123 * | Rdio | rdio.com | Yes | 3.6.0 |
124 * | Rdio | rd.io | Yes | 3.6.0 |
125 * | Spotify | spotify.com | Yes | 3.6.0 |
126 * | ------------ | -------------------- | ----- | --------- |
127 * | Imgur | imgur.com | Yes | 3.9.0 |
128 * | Meetup.com | meetup.com | Yes | 3.9.0 |
129 * | Meetup.com | meetu.ps | Yes | 3.9.0 |
130 * | ------------ | -------------------- | ----- | --------- |
131 * | Animoto | animoto.com | Yes | 4.0.0 |
132 * | Animoto | video214.com | Yes | 4.0.0 |
133 * | CollegeHumor | collegehumor.com | Yes | 4.0.0 |
134 * | Issuu | issuu.com | Yes | 4.0.0 |
135 * | Mixcloud | mixcloud.com | Yes | 4.0.0 |
136 * | Polldaddy | poll.fm | Yes | 4.0.0 |
137 * | TED | ted.com | Yes | 4.0.0 |
138 * | YouTube | youtube.com/playlist | Yes | 4.0.0 |
139 * | ------------ | -------------------- | ----- | --------- |
140 * | Vine | vine.co | Yes | 4.1.0 |
141 * | ------------ | -------------------- | ----- | --------- |
142 * | Tumblr | tumblr.com | Yes | 4.2.0 |
143 * | Kickstarter | kickstarter.com | Yes | 4.2.0 |
144 * | Kickstarter | kck.st | Yes | 4.2.0 |
145 * | ------------ | -------------------- | ----- | --------- |
147 * No longer supported providers:
149 * | ------------ | -------------------- | ----- | --------- | --------- |
150 * | Provider | Flavor | SSL | Since | Removed |
151 * | ------------ | -------------------- | ----- | --------- | --------- |
152 * | Qik | qik.com | Yes | 2.9.0 | 3.9.0 |
153 * | ------------ | -------------------- | ----- | --------- | --------- |
154 * | Viddler | viddler.com | Yes | 2.9.0 | 4.0.0 |
155 * | ------------ | -------------------- | ----- | --------- | --------- |
156 * | Revision3 | revision3.com | ! | 2.9.0 | 4.2.0 |
157 * | ------------ | -------------------- | ----- | --------- | --------- |
159 * @see wp_oembed_add_provider()
163 * @param array $providers An array of popular oEmbed providers.
165 $this->providers = apply_filters( 'oembed_providers', $providers );
167 // Fix any embeds that contain new lines in the middle of the HTML which breaks wpautop().
168 add_filter( 'oembed_dataparse', array($this, '_strip_newlines'), 10, 3 );
172 * Make private/protected methods readable for backwards compatibility.
177 * @param callable $name Method to call.
178 * @param array $arguments Arguments to pass when calling.
179 * @return mixed|bool Return value of the callback, false otherwise.
181 public function __call( $name, $arguments ) {
182 if ( in_array( $name, $this->compat_methods ) ) {
183 return call_user_func_array( array( $this, $name ), $arguments );
189 * Takes a URL and returns the corresponding oEmbed provider's URL, if there is one.
194 * @see WP_oEmbed::discover()
196 * @param string $url The URL to the content.
197 * @param string|array $args Optional provider arguments.
198 * @return bool|string False on failure, otherwise the oEmbed provider URL.
200 public function get_provider( $url, $args = '' ) {
204 if ( !isset($args['discover']) )
205 $args['discover'] = true;
207 foreach ( $this->providers as $matchmask => $data ) {
208 list( $providerurl, $regex ) = $data;
210 // Turn the asterisk-type provider URLs into regex
212 $matchmask = '#' . str_replace( '___wildcard___', '(.+)', preg_quote( str_replace( '*', '___wildcard___', $matchmask ), '#' ) ) . '#i';
213 $matchmask = preg_replace( '|^#http\\\://|', '#https?\://', $matchmask );
216 if ( preg_match( $matchmask, $url ) ) {
217 $provider = str_replace( '{format}', 'json', $providerurl ); // JSON is easier to deal with than XML
222 if ( !$provider && $args['discover'] )
223 $provider = $this->discover( $url );
229 * Add an oEmbed provider just-in-time when wp_oembed_add_provider() is called
230 * before the 'plugins_loaded' hook.
232 * The just-in-time addition is for the benefit of the 'oembed_providers' filter.
238 * @see wp_oembed_add_provider()
240 * @param string $format Format of URL that this provider can handle. You can use
241 * asterisks as wildcards.
242 * @param string $provider The URL to the oEmbed provider..
243 * @param bool $regex Optional. Whether the $format parameter is in a regex format.
246 public static function _add_provider_early( $format, $provider, $regex = false ) {
247 if ( empty( self::$early_providers['add'] ) ) {
248 self::$early_providers['add'] = array();
251 self::$early_providers['add'][ $format ] = array( $provider, $regex );
255 * Remove an oEmbed provider just-in-time when wp_oembed_remove_provider() is called
256 * before the 'plugins_loaded' hook.
258 * The just-in-time removal is for the benefit of the 'oembed_providers' filter.
264 * @see wp_oembed_remove_provider()
266 * @param string $format The format of URL that this provider can handle. You can use
267 * asterisks as wildcards.
269 public static function _remove_provider_early( $format ) {
270 if ( empty( self::$early_providers['remove'] ) ) {
271 self::$early_providers['remove'] = array();
274 self::$early_providers['remove'][] = $format;
278 * The do-it-all function that takes a URL and attempts to return the HTML.
280 * @see WP_oEmbed::fetch()
281 * @see WP_oEmbed::data2html()
283 * @param string $url The URL to the content that should be attempted to be embedded.
284 * @param array $args Optional arguments. Usually passed from a shortcode.
285 * @return false|string False on failure, otherwise the UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
287 public function get_html( $url, $args = '' ) {
288 $provider = $this->get_provider( $url, $args );
290 if ( !$provider || false === $data = $this->fetch( $provider, $url, $args ) )
294 * Filter the HTML returned by the oEmbed provider.
298 * @param string $data The returned oEmbed HTML.
299 * @param string $url URL of the content to be embedded.
300 * @param array $args Optional arguments, usually passed from a shortcode.
302 return apply_filters( 'oembed_result', $this->data2html( $data, $url ), $url, $args );
306 * Attempts to discover link tags at the given URL for an oEmbed provider.
308 * @param string $url The URL that should be inspected for discovery `<link>` tags.
309 * @return bool|string False on failure, otherwise the oEmbed provider URL.
311 public function discover( $url ) {
312 $providers = array();
315 * Filter oEmbed remote get arguments.
319 * @see WP_Http::request()
321 * @param array $args oEmbed remote get arguments.
322 * @param string $url URL to be inspected.
324 $args = apply_filters( 'oembed_remote_get_args', array(), $url );
327 $request = wp_safe_remote_get( $url, $args );
328 if ( $html = wp_remote_retrieve_body( $request ) ) {
331 * Filter the link types that contain oEmbed provider URLs.
335 * @param array $format Array of oEmbed link types. Accepts 'application/json+oembed',
336 * 'text/xml+oembed', and 'application/xml+oembed' (incorrect,
337 * used by at least Vimeo).
339 $linktypes = apply_filters( 'oembed_linktypes', array(
340 'application/json+oembed' => 'json',
341 'text/xml+oembed' => 'xml',
342 'application/xml+oembed' => 'xml',
346 $html = substr( $html, 0, stripos( $html, '</head>' ) );
350 foreach ( $linktypes as $linktype => $format ) {
351 if ( stripos($html, $linktype) ) {
357 if ( $tagfound && preg_match_all( '#<link([^<>]+)/?>#iU', $html, $links ) ) {
358 foreach ( $links[1] as $link ) {
359 $atts = shortcode_parse_atts( $link );
361 if ( !empty($atts['type']) && !empty($linktypes[$atts['type']]) && !empty($atts['href']) ) {
362 $providers[$linktypes[$atts['type']]] = htmlspecialchars_decode( $atts['href'] );
364 // Stop here if it's JSON (that's all we need)
365 if ( 'json' == $linktypes[$atts['type']] )
372 // JSON is preferred to XML
373 if ( !empty($providers['json']) )
374 return $providers['json'];
375 elseif ( !empty($providers['xml']) )
376 return $providers['xml'];
382 * Connects to a oEmbed provider and returns the result.
384 * @param string $provider The URL to the oEmbed provider.
385 * @param string $url The URL to the content that is desired to be embedded.
386 * @param array $args Optional arguments. Usually passed from a shortcode.
387 * @return bool|object False on failure, otherwise the result in the form of an object.
389 public function fetch( $provider, $url, $args = '' ) {
390 $args = wp_parse_args( $args, wp_embed_defaults( $url ) );
392 $provider = add_query_arg( 'maxwidth', (int) $args['width'], $provider );
393 $provider = add_query_arg( 'maxheight', (int) $args['height'], $provider );
394 $provider = add_query_arg( 'url', urlencode($url), $provider );
397 * Filter the oEmbed URL to be fetched.
401 * @param string $provider URL of the oEmbed provider.
402 * @param string $url URL of the content to be embedded.
403 * @param array $args Optional arguments, usually passed from a shortcode.
405 $provider = apply_filters( 'oembed_fetch_url', $provider, $url, $args );
407 foreach( array( 'json', 'xml' ) as $format ) {
408 $result = $this->_fetch_with_format( $provider, $format );
409 if ( is_wp_error( $result ) && 'not-implemented' == $result->get_error_code() )
411 return ( $result && ! is_wp_error( $result ) ) ? $result : false;
417 * Fetches result from an oEmbed provider for a specific format and complete provider URL
421 * @param string $provider_url_with_args URL to the provider with full arguments list (url, maxheight, etc.)
422 * @param string $format Format to use
423 * @return bool|object False on failure, otherwise the result in the form of an object.
425 private function _fetch_with_format( $provider_url_with_args, $format ) {
426 $provider_url_with_args = add_query_arg( 'format', $format, $provider_url_with_args );
428 /** This filter is documented in wp-includes/class-oembed.php */
429 $args = apply_filters( 'oembed_remote_get_args', array(), $provider_url_with_args );
431 $response = wp_safe_remote_get( $provider_url_with_args, $args );
432 if ( 501 == wp_remote_retrieve_response_code( $response ) )
433 return new WP_Error( 'not-implemented' );
434 if ( ! $body = wp_remote_retrieve_body( $response ) )
436 $parse_method = "_parse_$format";
437 return $this->$parse_method( $body );
441 * Parses a json response body.
446 private function _parse_json( $response_body ) {
447 return ( ( $data = json_decode( trim( $response_body ) ) ) && is_object( $data ) ) ? $data : false;
451 * Parses an XML response body.
456 private function _parse_xml( $response_body ) {
457 if ( ! function_exists( 'libxml_disable_entity_loader' ) )
460 $loader = libxml_disable_entity_loader( true );
461 $errors = libxml_use_internal_errors( true );
463 $return = $this->_parse_xml_body( $response_body );
465 libxml_use_internal_errors( $errors );
466 libxml_disable_entity_loader( $loader );
472 * Helper function for parsing an XML response body.
477 private function _parse_xml_body( $response_body ) {
478 if ( ! function_exists( 'simplexml_import_dom' ) || ! class_exists( 'DOMDocument' ) )
481 $dom = new DOMDocument;
482 $success = $dom->loadXML( $response_body );
486 if ( isset( $dom->doctype ) )
489 foreach ( $dom->childNodes as $child ) {
490 if ( XML_DOCUMENT_TYPE_NODE === $child->nodeType )
494 $xml = simplexml_import_dom( $dom );
498 $return = new stdClass;
499 foreach ( $xml as $key => $value ) {
500 $return->$key = (string) $value;
507 * Converts a data object from {@link WP_oEmbed::fetch()} and returns the HTML.
509 * @param object $data A data object result from an oEmbed provider.
510 * @param string $url The URL to the content that is desired to be embedded.
511 * @return false|string False on error, otherwise the HTML needed to embed.
513 public function data2html( $data, $url ) {
514 if ( ! is_object( $data ) || empty( $data->type ) )
519 switch ( $data->type ) {
521 if ( empty( $data->url ) || empty( $data->width ) || empty( $data->height ) )
523 if ( ! is_string( $data->url ) || ! is_numeric( $data->width ) || ! is_numeric( $data->height ) )
526 $title = ! empty( $data->title ) && is_string( $data->title ) ? $data->title : '';
527 $return = '<a href="' . esc_url( $url ) . '"><img src="' . esc_url( $data->url ) . '" alt="' . esc_attr($title) . '" width="' . esc_attr($data->width) . '" height="' . esc_attr($data->height) . '" /></a>';
532 if ( ! empty( $data->html ) && is_string( $data->html ) )
533 $return = $data->html;
537 if ( ! empty( $data->title ) && is_string( $data->title ) )
538 $return = '<a href="' . esc_url( $url ) . '">' . esc_html( $data->title ) . '</a>';
546 * Filter the returned oEmbed HTML.
548 * Use this filter to add support for custom data types, or to filter the result.
552 * @param string $return The returned oEmbed HTML.
553 * @param object $data A data object result from an oEmbed provider.
554 * @param string $url The URL of the content to be embedded.
556 return apply_filters( 'oembed_dataparse', $return, $data, $url );
560 * Strip any new lines from the HTML.
563 * @param string $html Existing HTML.
564 * @param object $data Data object from WP_oEmbed::data2html()
565 * @param string $url The original URL passed to oEmbed.
566 * @return string Possibly modified $html
568 public function _strip_newlines( $html, $data, $url ) {
569 if ( false === strpos( $html, "\n" ) ) {
576 $search = array( "\t", "\n", "\r", ' ' );
577 $replace = array( '__TAB__', '__NL__', '__CR__', '__SPACE__' );
578 $tokenized = str_replace( $search, $replace, $html );
580 preg_match_all( '#(<pre[^>]*>.+?</pre>)#i', $tokenized, $matches, PREG_SET_ORDER );
581 foreach ( $matches as $i => $match ) {
582 $tag_html = str_replace( $replace, $search, $match[0] );
583 $tag_token = $token . $i;
585 $found[ $tag_token ] = $tag_html;
586 $html = str_replace( $tag_html, $tag_token, $html, $count );
589 $replaced = str_replace( $replace, $search, $html );
590 $stripped = str_replace( array( "\r\n", "\n" ), '', $replaced );
591 $pre = array_values( $found );
592 $tokens = array_keys( $found );
594 return str_replace( $tokens, $pre, $stripped );
599 * Returns the initialized {@link WP_oEmbed} object
606 * @return WP_oEmbed object.
608 function _wp_oembed_get_object() {
611 if ( is_null($wp_oembed) )
612 $wp_oembed = new WP_oEmbed();