<?php
/**
- * API for fetching the HTML to embed remote content based on a provided URL.
- * Used internally by the {@link WP_Embed} class, but is designed to be generic.
+ * API for fetching the HTML to embed remote content based on a provided URL
+ *
+ * Used internally by the WP_Embed class, but is designed to be generic.
*
* @link https://codex.wordpress.org/oEmbed oEmbed Codex Article
* @link http://oembed.com/ oEmbed Homepage
*/
/**
- * oEmbed class.
+ * Core class used to implement oEmbed functionality.
*
- * @package WordPress
- * @subpackage oEmbed
* @since 2.9.0
*/
class WP_oEmbed {
+
+ /**
+ * A list of oEmbed providers.
+ *
+ * @since 2.9.0
+ * @access public
+ * @var array
+ */
public $providers = array();
+
/**
+ * A list of an early oEmbed providers.
+ *
+ * @since 4.0.0
+ * @access public
* @static
* @var array
*/
public static $early_providers = array();
+ /**
+ * A list of private/protected methods, used for backward compatibility.
+ *
+ * @since 4.2.0
+ * @access private
+ * @var array
+ */
private $compat_methods = array( '_fetch_with_format', '_parse_json', '_parse_xml', '_parse_body' );
/**
- * Constructor
+ * Constructor.
*
* @since 2.9.0
+ * @access public
*/
public function __construct() {
$host = urlencode( home_url() );
'#https://youtu\.be/.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ),
'#https?://(.+\.)?vimeo\.com/.*#i' => array( 'http://vimeo.com/api/oembed.{format}', true ),
'#https?://(www\.)?dailymotion\.com/.*#i' => array( 'https://www.dailymotion.com/services/oembed', true ),
- 'http://dai.ly/*' => array( 'https://www.dailymotion.com/services/oembed', false ),
+ '#https?://dai.ly/.*#i' => array( 'https://www.dailymotion.com/services/oembed', true ),
'#https?://(www\.)?flickr\.com/.*#i' => array( 'https://www.flickr.com/services/oembed/', true ),
'#https?://flic\.kr/.*#i' => array( 'https://www.flickr.com/services/oembed/', true ),
'#https?://(.+\.)?smugmug\.com/.*#i' => array( 'http://api.smugmug.com/services/oembed/', true ),
'#https?://(.+\.)?polldaddy\.com/.*#i' => array( 'https://polldaddy.com/oembed/', true ),
'#https?://poll\.fm/.*#i' => array( 'https://polldaddy.com/oembed/', true ),
'#https?://(www\.)?funnyordie\.com/videos/.*#i' => array( 'http://www.funnyordie.com/oembed', true ),
- '#https?://(www\.)?twitter\.com/.+?/status(es)?/.*#i' => array( 'https://api.twitter.com/1/statuses/oembed.{format}', true ),
+ '#https?://(www\.)?twitter\.com/.+?/status(es)?/.*#i' => array( 'https://publish.twitter.com/oembed', true ),
+ '#https?://(www\.)?twitter\.com/.+?/timelines/.*#i' => array( 'https://publish.twitter.com/oembed', true ),
+ '#https?://(www\.)?twitter\.com/i/moments/.*#i' => array( 'https://publish.twitter.com/oembed', true ),
'#https?://vine.co/v/.*#i' => array( 'https://vine.co/oembed.{format}', true ),
'#https?://(www\.)?soundcloud\.com/.*#i' => array( 'http://soundcloud.com/oembed', true ),
'#https?://(.+?\.)?slideshare\.net/.*#i' => array( 'https://www.slideshare.net/api/oembed/2', true ),
self::$early_providers = array();
/**
- * Filter the list of whitelisted oEmbed providers.
+ * Filters the list of whitelisted oEmbed providers.
*
* Since WordPress 4.4, oEmbed discovery is enabled for all users and allows embedding of sanitized
* iframes. The providers in this list are whitelisted, meaning they are trusted and allowed to
*
* Supported providers:
*
- * | Provider | Flavor | HTTPS | Since |
- * | ------------ | -------------------- | :---: | --------- |
- * | Dailymotion | dailymotion.com | Yes | 2.9.0 |
- * | Flickr | flickr.com | Yes | 2.9.0 |
- * | Hulu | hulu.com | Yes | 2.9.0 |
- * | Photobucket | photobucket.com | No | 2.9.0 |
- * | Scribd | scribd.com | Yes | 2.9.0 |
- * | Vimeo | vimeo.com | Yes | 2.9.0 |
- * | WordPress.tv | wordpress.tv | Yes | 2.9.0 |
- * | YouTube | youtube.com/watch | Yes | 2.9.0 |
- * | Funny or Die | funnyordie.com | Yes | 3.0.0 |
- * | Polldaddy | polldaddy.com | Yes | 3.0.0 |
- * | SmugMug | smugmug.com | Yes | 3.0.0 |
- * | YouTube | youtu.be | Yes | 3.0.0 |
- * | Twitter | twitter.com | Yes | 3.4.0 |
- * | Instagram | instagram.com | Yes | 3.5.0 |
- * | Instagram | instagr.am | Yes | 3.5.0 |
- * | Slideshare | slideshare.net | Yes | 3.5.0 |
- * | SoundCloud | soundcloud.com | Yes | 3.5.0 |
- * | Dailymotion | dai.ly | No | 3.6.0 |
- * | Flickr | flic.kr | Yes | 3.6.0 |
- * | Spotify | spotify.com | Yes | 3.6.0 |
- * | Imgur | imgur.com | Yes | 3.9.0 |
- * | Meetup.com | meetup.com | Yes | 3.9.0 |
- * | Meetup.com | meetu.ps | Yes | 3.9.0 |
- * | Animoto | animoto.com | Yes | 4.0.0 |
- * | Animoto | video214.com | Yes | 4.0.0 |
- * | CollegeHumor | collegehumor.com | Yes | 4.0.0 |
- * | Issuu | issuu.com | Yes | 4.0.0 |
- * | Mixcloud | mixcloud.com | Yes | 4.0.0 |
- * | Polldaddy | poll.fm | Yes | 4.0.0 |
- * | TED | ted.com | Yes | 4.0.0 |
- * | YouTube | youtube.com/playlist | Yes | 4.0.0 |
- * | Vine | vine.co | Yes | 4.1.0 |
- * | Tumblr | tumblr.com | Yes | 4.2.0 |
- * | Kickstarter | kickstarter.com | Yes | 4.2.0 |
- * | Kickstarter | kck.st | Yes | 4.2.0 |
- * | Cloudup | cloudup.com | Yes | 4.4.0 |
- * | ReverbNation | reverbnation.com | Yes | 4.4.0 |
- * | VideoPress | videopress.com | Yes | 4.4.0 |
- * | Reddit | reddit.com | Yes | 4.4.0 |
- * | Speaker Deck | speakerdeck.com | Yes | 4.4.0 |
+ * | Provider | Flavor | Supports HTTPS | Since |
+ * | ------------ | --------------------- | :------------: | --------- |
+ * | Dailymotion | dailymotion.com | Yes | 2.9.0 |
+ * | Flickr | flickr.com | Yes | 2.9.0 |
+ * | Hulu | hulu.com | Yes | 2.9.0 |
+ * | Photobucket | photobucket.com | No | 2.9.0 |
+ * | Scribd | scribd.com | Yes | 2.9.0 |
+ * | Vimeo | vimeo.com | Yes | 2.9.0 |
+ * | WordPress.tv | wordpress.tv | Yes | 2.9.0 |
+ * | YouTube | youtube.com/watch | Yes | 2.9.0 |
+ * | Funny or Die | funnyordie.com | Yes | 3.0.0 |
+ * | Polldaddy | polldaddy.com | Yes | 3.0.0 |
+ * | SmugMug | smugmug.com | Yes | 3.0.0 |
+ * | YouTube | youtu.be | Yes | 3.0.0 |
+ * | Twitter | twitter.com | Yes | 3.4.0 |
+ * | Instagram | instagram.com | Yes | 3.5.0 |
+ * | Instagram | instagr.am | Yes | 3.5.0 |
+ * | Slideshare | slideshare.net | Yes | 3.5.0 |
+ * | SoundCloud | soundcloud.com | Yes | 3.5.0 |
+ * | Dailymotion | dai.ly | Yes | 3.6.0 |
+ * | Flickr | flic.kr | Yes | 3.6.0 |
+ * | Spotify | spotify.com | Yes | 3.6.0 |
+ * | Imgur | imgur.com | Yes | 3.9.0 |
+ * | Meetup.com | meetup.com | Yes | 3.9.0 |
+ * | Meetup.com | meetu.ps | Yes | 3.9.0 |
+ * | Animoto | animoto.com | Yes | 4.0.0 |
+ * | Animoto | video214.com | Yes | 4.0.0 |
+ * | CollegeHumor | collegehumor.com | Yes | 4.0.0 |
+ * | Issuu | issuu.com | Yes | 4.0.0 |
+ * | Mixcloud | mixcloud.com | Yes | 4.0.0 |
+ * | Polldaddy | poll.fm | Yes | 4.0.0 |
+ * | TED | ted.com | Yes | 4.0.0 |
+ * | YouTube | youtube.com/playlist | Yes | 4.0.0 |
+ * | Vine | vine.co | Yes | 4.1.0 |
+ * | Tumblr | tumblr.com | Yes | 4.2.0 |
+ * | Kickstarter | kickstarter.com | Yes | 4.2.0 |
+ * | Kickstarter | kck.st | Yes | 4.2.0 |
+ * | Cloudup | cloudup.com | Yes | 4.4.0 |
+ * | ReverbNation | reverbnation.com | Yes | 4.4.0 |
+ * | VideoPress | videopress.com | Yes | 4.4.0 |
+ * | Reddit | reddit.com | Yes | 4.4.0 |
+ * | Speaker Deck | speakerdeck.com | Yes | 4.4.0 |
+ * | Twitter | twitter.com/timelines | Yes | 4.5.0 |
+ * | Twitter | twitter.com/moments | Yes | 4.5.0 |
*
* No longer supported providers:
*
- * | Provider | Flavor | HTTPS | Since | Removed |
- * | ------------ | -------------------- | :---: | --------- | --------- |
- * | Qik | qik.com | Yes | 2.9.0 | 3.9.0 |
- * | Viddler | viddler.com | Yes | 2.9.0 | 4.0.0 |
- * | Revision3 | revision3.com | No | 2.9.0 | 4.2.0 |
- * | Blip | blip.tv | No | 2.9.0 | 4.4.0 |
- * | Rdio | rdio.com | Yes | 3.6.0 | 4.4.1 |
- * | Rdio | rd.io | Yes | 3.6.0 | 4.4.1 |
+ * | Provider | Flavor | Supports HTTPS | Since | Removed |
+ * | ------------ | -------------------- | :------------: | --------- | --------- |
+ * | Qik | qik.com | Yes | 2.9.0 | 3.9.0 |
+ * | Viddler | viddler.com | Yes | 2.9.0 | 4.0.0 |
+ * | Revision3 | revision3.com | No | 2.9.0 | 4.2.0 |
+ * | Blip | blip.tv | No | 2.9.0 | 4.4.0 |
+ * | Rdio | rdio.com | Yes | 3.6.0 | 4.4.1 |
+ * | Rdio | rd.io | Yes | 3.6.0 | 4.4.1 |
*
* @see wp_oembed_add_provider()
*
}
/**
- * Make private/protected methods readable for backwards compatibility.
+ * Exposes private/protected methods for backward compatibility.
*
* @since 4.0.0
* @access public
* @return false|string False on failure, otherwise the oEmbed provider URL.
*/
public function get_provider( $url, $args = '' ) {
+ $args = wp_parse_args( $args );
$provider = false;
}
/**
- * Add an oEmbed provider just-in-time when wp_oembed_add_provider() is called
- * before the 'plugins_loaded' hook.
+ * Adds an oEmbed provider.
+ *
+ * The provider is removed just-in-time when wp_oembed_add_provider() is called before
+ * the {@see 'plugins_loaded'} hook.
*
- * The just-in-time addition is for the benefit of the 'oembed_providers' filter.
+ * The just-in-time addition is for the benefit of the {@see 'oembed_providers'} filter.
*
+ * @static
* @since 4.0.0
* @access public
- * @static
*
* @see wp_oembed_add_provider()
*
}
/**
- * Remove an oEmbed provider just-in-time when wp_oembed_remove_provider() is called
- * before the 'plugins_loaded' hook.
+ * Removes an oEmbed provider.
+ *
+ * The provider is removed just-in-time when wp_oembed_remove_provider() is called before
+ * the {@see 'plugins_loaded'} hook.
*
- * The just-in-time removal is for the benefit of the 'oembed_providers' filter.
+ * The just-in-time removal is for the benefit of the {@see 'oembed_providers'} filter.
*
* @since 4.0.0
* @access public
* @see WP_oEmbed::fetch()
* @see WP_oEmbed::data2html()
*
- * @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.
+ * @since 2.9.0
+ * @access public
+ *
+ * @param string $url The URL to the content that should be attempted to be embedded.
+ * @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
* @return false|string False on failure, otherwise the UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
*/
public function get_html( $url, $args = '' ) {
+ $args = wp_parse_args( $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 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;
+ }
+
$provider = $this->get_provider( $url, $args );
- if ( !$provider || false === $data = $this->fetch( $provider, $url, $args ) )
+ if ( ! $provider || false === $data = $this->fetch( $provider, $url, $args ) ) {
return false;
+ }
/**
- * Filter the HTML returned by the oEmbed provider.
+ * Filters the HTML returned by the oEmbed provider.
*
* @since 2.9.0
*
/**
* Attempts to discover link tags at the given URL for an oEmbed provider.
*
+ * @since 2.9.0
+ * @access public
+ *
* @param string $url The URL that should be inspected for discovery `<link>` tags.
* @return false|string False on failure, otherwise the oEmbed provider URL.
*/
public function discover( $url ) {
$providers = array();
+ $args = array(
+ 'limit_response_size' => 153600, // 150 KB
+ );
/**
- * Filter oEmbed remote get arguments.
+ * Filters oEmbed remote get arguments.
*
* @since 4.0.0
*
* @param array $args oEmbed remote get arguments.
* @param string $url URL to be inspected.
*/
- $args = apply_filters( 'oembed_remote_get_args', array(), $url );
+ $args = apply_filters( 'oembed_remote_get_args', $args, $url );
// Fetch URL content
$request = wp_safe_remote_get( $url, $args );
if ( $html = wp_remote_retrieve_body( $request ) ) {
/**
- * Filter the link types that contain oEmbed provider URLs.
+ * Filters the link types that contain oEmbed provider URLs.
*
* @since 2.9.0
*
) );
// Strip <body>
- $html = substr( $html, 0, stripos( $html, '</head>' ) );
+ if ( $html_head_end = stripos( $html, '</head>' ) ) {
+ $html = substr( $html, 0, $html_head_end );
+ }
// Do a quick check
$tagfound = false;
/**
* Connects to a oEmbed provider and returns the result.
*
- * @param string $provider The URL to the oEmbed provider.
- * @param string $url The URL to the content that is desired to be embedded.
- * @param array $args Optional arguments. Usually passed from a shortcode.
+ * @since 2.9.0
+ * @access public
+ *
+ * @param string $provider The URL to the oEmbed provider.
+ * @param string $url The URL to the content that is desired to be embedded.
+ * @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
* @return false|object False on failure, otherwise the result in the form of an object.
*/
public function fetch( $provider, $url, $args = '' ) {
$provider = add_query_arg( 'url', urlencode($url), $provider );
/**
- * Filter the oEmbed URL to be fetched.
+ * Filters the oEmbed URL to be fetched.
*
* @since 2.9.0
*
*
* @since 3.0.0
* @access private
+ *
* @param string $provider_url_with_args URL to the provider with full arguments list (url, maxheight, etc.)
* @param string $format Format to use
* @return false|object|WP_Error False on failure, otherwise the result in the form of an object.
}
/**
- * Helper function for parsing an XML response body.
+ * Serves as a helper function for parsing an XML response body.
*
* @since 3.6.0
* @access private
}
/**
- * Converts a data object from {@link WP_oEmbed::fetch()} and returns the HTML.
+ * Converts a data object from WP_oEmbed::fetch() and returns the HTML.
+ *
+ * @since 2.9.0
+ * @access public
*
* @param object $data A data object result from an oEmbed provider.
* @param string $url The URL to the content that is desired to be embedded.
}
/**
- * Filter the returned oEmbed HTML.
+ * Filters the returned oEmbed HTML.
*
* Use this filter to add support for custom data types, or to filter the result.
*
}
/**
- * Strip any new lines from the HTML.
+ * Strips any new lines from the HTML.
*
+ * @since 2.9.0 as strip_scribd_newlines()
+ * @since 3.0.0
* @access public
+ *
* @param string $html Existing HTML.
* @param object $data Data object from WP_oEmbed::data2html()
* @param string $url The original URL passed to oEmbed.
}
/**
- * Returns the initialized {@link WP_oEmbed} object
+ * Returns the initialized WP_oEmbed object.
*
* @since 2.9.0
* @access private
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff