Ticket #32246: class-oembed.php.patch

wp-includes/class-oembed.php

@@ -11 +11 @@
  */
 
 /**
- * oEmbed class.
+ * WordPress oEmbed class.
  *
  * @package WordPress
  * @subpackage oEmbed
@@ -18 +18 @@
  * @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 backwards 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() );
@@ -283 +304 @@
          * @see WP_oEmbed::fetch()
          * @see WP_oEmbed::data2html()
          *
+         * @since 2.9.0
+         * @access public
+         *
          * @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.
          * @return false|string False on failure, otherwise the UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
@@ -308 +332 @@
         /**
          * 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.
          */
@@ -389 +416 @@
         /**
          * Connects to a oEmbed provider and returns the result.
          *
+         * @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 $args Optional arguments. Usually passed from a shortcode.
@@ -426 +456 @@
          *
          * @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.
@@ -524 +555 @@
         /**
          * Converts a data object from {@link 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.
          * @return false|string False on error, otherwise the HTML needed to embed.
@@ -577 +611 @@
         /**
          * Strip any new lines from the HTML.
          *
+         * @since 2.9.0
+         * @since 3.0.0 Renamed from strip_scribd_newlines() to _strip_newlines()
          * @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.