X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7f1521bf193b382565eb753043c161f4cb3fcda7..8d3bb1a5dcfdea9857d3c88c3751f09593e34dc8:/wp-includes/class-oembed.php diff --git a/wp-includes/class-oembed.php b/wp-includes/class-oembed.php index 4e888367..9790d266 100644 --- a/wp-includes/class-oembed.php +++ b/wp-includes/class-oembed.php @@ -1,7 +1,8 @@ array( 'http://www.youtube.com/oembed', true ), - '#https://(www\.)?youtube\.com/watch.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ), - '#http://(www\.)?youtube\.com/playlist.*#i' => array( 'http://www.youtube.com/oembed', true ), - '#https://(www\.)?youtube\.com/playlist.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ), - '#http://youtu\.be/.*#i' => array( 'http://www.youtube.com/oembed', true ), - '#https://youtu\.be/.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ), - 'http://blip.tv/*' => array( 'http://blip.tv/oembed/', false ), - '#https?://(.+\.)?vimeo\.com/.*#i' => array( 'http://vimeo.com/api/oembed.{format}', true ), - '#https?://(www\.)?dailymotion\.com/.*#i' => array( 'http://www.dailymotion.com/services/oembed', true ), - 'http://dai.ly/*' => array( 'http://www.dailymotion.com/services/oembed', false ), - '#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?://(www\.)?hulu\.com/watch/.*#i' => array( 'http://www.hulu.com/api/oembed.{format}', true ), - 'http://i*.photobucket.com/albums/*' => array( 'http://photobucket.com/oembed', false ), - 'http://gi*.photobucket.com/groups/*' => array( 'http://photobucket.com/oembed', false ), - '#https?://(www\.)?scribd\.com/doc/.*#i' => array( 'http://www.scribd.com/services/oembed', true ), - '#https?://wordpress.tv/.*#i' => array( 'http://wordpress.tv/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?://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 ), - '#https?://instagr(\.am|am\.com)/p/.*#i' => array( 'https://api.instagram.com/oembed', true ), - '#https?://(www\.)?rdio\.com/.*#i' => array( 'http://www.rdio.com/api/oembed/', true ), - '#https?://rd\.io/x/.*#i' => array( 'http://www.rdio.com/api/oembed/', true ), - '#https?://(open|play)\.spotify\.com/.*#i' => array( 'https://embed.spotify.com/oembed/', true ), - '#https?://(.+\.)?imgur\.com/.*#i' => array( 'http://api.imgur.com/oembed', true ), - '#https?://(www\.)?meetu(\.ps|p\.com)/.*#i' => array( 'http://api.meetup.com/oembed', true ), - '#https?://(www\.)?issuu\.com/.+/docs/.+#i' => array( 'http://issuu.com/oembed_wp', true ), - '#https?://(www\.)?collegehumor\.com/video/.*#i' => array( 'http://www.collegehumor.com/oembed.{format}', true ), - '#https?://(www\.)?mixcloud\.com/.*#i' => array( 'http://www.mixcloud.com/oembed', true ), - '#https?://(www\.|embed\.)?ted\.com/talks/.*#i' => array( 'http://www.ted.com/talks/oembed.{format}', true ), - '#https?://(www\.)?(animoto|video214)\.com/play/.*#i' => array( 'http://animoto.com/oembeds/create', true ), - '#https?://(.+)\.tumblr\.com/post/.*#i' => array( 'https://www.tumblr.com/oembed/1.0', true ), - '#https?://(www\.)?kickstarter\.com/projects/.*#i' => array( 'https://www.kickstarter.com/services/oembed', true ), - '#https?://kck\.st/.*#i' => array( 'https://www.kickstarter.com/services/oembed', true ), + '#http://((m|www)\.)?youtube\.com/watch.*#i' => array( 'http://www.youtube.com/oembed', true ), + '#https://((m|www)\.)?youtube\.com/watch.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ), + '#http://((m|www)\.)?youtube\.com/playlist.*#i' => array( 'http://www.youtube.com/oembed', true ), + '#https://((m|www)\.)?youtube\.com/playlist.*#i' => array( 'http://www.youtube.com/oembed?scheme=https', true ), + '#http://youtu\.be/.*#i' => array( 'http://www.youtube.com/oembed', true ), + '#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 ), + '#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?://(www\.)?hulu\.com/watch/.*#i' => array( 'http://www.hulu.com/api/oembed.{format}', true ), + 'http://i*.photobucket.com/albums/*' => array( 'http://api.photobucket.com/oembed', false ), + 'http://gi*.photobucket.com/groups/*' => array( 'http://api.photobucket.com/oembed', false ), + '#https?://(www\.)?scribd\.com/doc/.*#i' => array( 'http://www.scribd.com/services/oembed', true ), + '#https?://wordpress.tv/.*#i' => array( 'http://wordpress.tv/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://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 ), + '#https?://(www\.)?instagr(\.am|am\.com)/p/.*#i' => array( 'https://api.instagram.com/oembed', true ), + '#https?://(open|play)\.spotify\.com/.*#i' => array( 'https://embed.spotify.com/oembed/', true ), + '#https?://(.+\.)?imgur\.com/.*#i' => array( 'http://api.imgur.com/oembed', true ), + '#https?://(www\.)?meetu(\.ps|p\.com)/.*#i' => array( 'http://api.meetup.com/oembed', true ), + '#https?://(www\.)?issuu\.com/.+/docs/.+#i' => array( 'http://issuu.com/oembed_wp', true ), + '#https?://(www\.)?collegehumor\.com/video/.*#i' => array( 'http://www.collegehumor.com/oembed.{format}', true ), + '#https?://(www\.)?mixcloud\.com/.*#i' => array( 'http://www.mixcloud.com/oembed', true ), + '#https?://(www\.|embed\.)?ted\.com/talks/.*#i' => array( 'http://www.ted.com/talks/oembed.{format}', true ), + '#https?://(www\.)?(animoto|video214)\.com/play/.*#i' => array( 'https://animoto.com/oembeds/create', true ), + '#https?://(.+)\.tumblr\.com/post/.*#i' => array( 'https://www.tumblr.com/oembed/1.0', true ), + '#https?://(www\.)?kickstarter\.com/projects/.*#i' => array( 'https://www.kickstarter.com/services/oembed', true ), + '#https?://kck\.st/.*#i' => array( 'https://www.kickstarter.com/services/oembed', true ), + '#https?://cloudup\.com/.*#i' => array( 'https://cloudup.com/oembed', true ), + '#https?://(www\.)?reverbnation\.com/.*#i' => array( 'https://www.reverbnation.com/oembed', true ), + '#https?://videopress.com/v/.*#' => array( 'https://public-api.wordpress.com/oembed/1.0/?for=' . $host, true ), + '#https?://(www\.)?reddit\.com/r/[^/]+/comments/.*#i' => array( 'https://www.reddit.com/oembed', true ), + '#https?://(www\.)?speakerdeck\.com/.*#i' => array( 'https://speakerdeck.com/oembed.{format}', true ), ); if ( ! empty( self::$early_providers['add'] ) ) { @@ -86,75 +115,69 @@ class WP_oEmbed { self::$early_providers = array(); /** - * Filter the list of oEmbed providers. + * Filters the list of whitelisted oEmbed providers. * - * Discovery is disabled for users lacking the unfiltered_html capability. - * Only providers in this array will be used for those users. + * 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 + * embed any content, such as iframes, videos, JavaScript, and arbitrary HTML. * * Supported providers: * - * | ------------ | -------------------- | ----- | --------- | - * | Provider | Flavor | SSL | Since | - * | ------------ | -------------------- | ----- | --------- | - * | Blip | blip.tv | ! | 2.9.0 | - * | Dailymotion | dailymotion.com | Yes | 2.9.0 | - * | Flickr | flickr.com | Yes | 2.9.0 | - * | Hulu | hulu.com | Yes | 2.9.0 | - * | Photobucket | photobucket.com | ! | 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 | ! | 3.6.0 | - * | Flickr | flic.kr | Yes | 3.6.0 | - * | Rdio | rdio.com | Yes | 3.6.0 | - * | Rdio | rd.io | 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 | - * | ------------ | -------------------- | ----- | --------- | + * | 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 | SSL | 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 | ! | 2.9.0 | 4.2.0 | - * | ------------ | -------------------- | ----- | --------- | --------- | + * | 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() * @@ -169,7 +192,7 @@ class WP_oEmbed { } /** - * Make private/protected methods readable for backwards compatibility. + * Exposes private/protected methods for backward compatibility. * * @since 4.0.0 * @access public @@ -195,9 +218,10 @@ class WP_oEmbed { * * @param string $url The URL to the content. * @param string|array $args Optional provider arguments. - * @return bool|string False on failure, otherwise the oEmbed provider URL. + * @return false|string False on failure, otherwise the oEmbed provider URL. */ public function get_provider( $url, $args = '' ) { + $args = wp_parse_args( $args ); $provider = false; @@ -226,14 +250,16 @@ class WP_oEmbed { } /** - * Add an oEmbed provider just-in-time when wp_oembed_add_provider() is called - * before the 'plugins_loaded' hook. + * Adds an oEmbed provider. * - * The just-in-time addition is for the benefit of the 'oembed_providers' filter. + * 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 {@see 'oembed_providers'} filter. + * + * @static * @since 4.0.0 * @access public - * @static * * @see wp_oembed_add_provider() * @@ -252,10 +278,12 @@ class WP_oEmbed { } /** - * 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 @@ -280,18 +308,45 @@ class WP_oEmbed { * @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 * @@ -305,14 +360,20 @@ class WP_oEmbed { /** * 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 `` tags. - * @return bool|string False on failure, otherwise the oEmbed provider URL. + * @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 * @@ -321,14 +382,14 @@ class WP_oEmbed { * @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 * @@ -343,7 +404,9 @@ class WP_oEmbed { ) ); // Strip - $html = substr( $html, 0, stripos( $html, '' ) ); + if ( $html_head_end = stripos( $html, '' ) ) { + $html = substr( $html, 0, $html_head_end ); + } // Do a quick check $tagfound = false; @@ -381,10 +444,13 @@ class WP_oEmbed { /** * 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. - * @return bool|object False on failure, otherwise the result in the form of an object. + * @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 = '' ) { $args = wp_parse_args( $args, wp_embed_defaults( $url ) ); @@ -394,7 +460,7 @@ class WP_oEmbed { $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 * @@ -404,7 +470,7 @@ class WP_oEmbed { */ $provider = apply_filters( 'oembed_fetch_url', $provider, $url, $args ); - foreach( array( 'json', 'xml' ) as $format ) { + foreach ( array( 'json', 'xml' ) as $format ) { $result = $this->_fetch_with_format( $provider, $format ); if ( is_wp_error( $result ) && 'not-implemented' == $result->get_error_code() ) continue; @@ -418,9 +484,10 @@ class WP_oEmbed { * * @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 bool|object False on failure, otherwise the result in the form of an object. + * @return false|object|WP_Error False on failure, otherwise the result in the form of an object. */ private function _fetch_with_format( $provider_url_with_args, $format ) { $provider_url_with_args = add_query_arg( 'format', $format, $provider_url_with_args ); @@ -442,9 +509,13 @@ class WP_oEmbed { * * @since 3.0.0 * @access private + * + * @param string $response_body + * @return object|false */ private function _parse_json( $response_body ) { - return ( ( $data = json_decode( trim( $response_body ) ) ) && is_object( $data ) ) ? $data : false; + $data = json_decode( trim( $response_body ) ); + return ( $data && is_object( $data ) ) ? $data : false; } /** @@ -452,6 +523,9 @@ class WP_oEmbed { * * @since 3.0.0 * @access private + * + * @param string $response_body + * @return object|false */ private function _parse_xml( $response_body ) { if ( ! function_exists( 'libxml_disable_entity_loader' ) ) @@ -469,13 +543,16 @@ class WP_oEmbed { } /** - * 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 + * + * @param string $response_body + * @return object|false */ private function _parse_xml_body( $response_body ) { - if ( ! function_exists( 'simplexml_import_dom' ) || ! class_exists( 'DOMDocument' ) ) + if ( ! function_exists( 'simplexml_import_dom' ) || ! class_exists( 'DOMDocument', false ) ) return false; $dom = new DOMDocument; @@ -504,7 +581,10 @@ class WP_oEmbed { } /** - * 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. @@ -543,7 +623,7 @@ class WP_oEmbed { } /** - * 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. * @@ -557,9 +637,12 @@ class WP_oEmbed { } /** - * 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. @@ -596,20 +679,20 @@ class WP_oEmbed { } /** - * Returns the initialized {@link WP_oEmbed} object + * Returns the initialized WP_oEmbed object. * * @since 2.9.0 * @access private * - * @see WP_oEmbed + * @staticvar WP_oEmbed $wp_oembed * * @return WP_oEmbed object. */ function _wp_oembed_get_object() { - static $wp_oembed; + static $wp_oembed = null; - if ( is_null($wp_oembed) ) + if ( is_null( $wp_oembed ) ) { $wp_oembed = new WP_oEmbed(); - + } return $wp_oembed; }