WordPress 4.1.1-scripts
[autoinstalls/wordpress.git] / wp-includes / rss.php
index 88bfa62dcb52fbea212d8210cf9ac11fffe8e31b..a7c43f44de24ee3c578080b22eadd564f72253a3 100644 (file)
@@ -10,6 +10,7 @@
  *
  * @package External
  * @subpackage MagpieRSS
+ * @deprecated 3.0.0 Use SimplePie instead.
  */
 
 /**
  */
 _deprecated_file( basename( __FILE__ ), '3.0', WPINC . '/class-simplepie.php' );
 
-/*
- * Hook to use another RSS object instead of MagpieRSS
+/**
+ * Fires before MagpieRSS is loaded, to optionally replace it.
+ *
+ * @since 2.3.0
+ * @deprecated 3.0.0
  */
-do_action('load_feed_engine');
+do_action( 'load_feed_engine' );
 
 /** RSS feed constant. */
 define('RSS', 'RSS');
@@ -63,7 +67,6 @@ class MagpieRSS {
                if ( !is_resource($parser) )
                        trigger_error( "Failed to create an instance of PHP's XML parser. http://www.php.net/manual/en/ref.xml.php");
 
-
                $this->parser = $parser;
 
                # pass in parser, and a reference to this object
@@ -167,7 +170,6 @@ class MagpieRSS {
 
                        $this->incontent = $el;
 
-
                }
 
                // if inside an Atom content construct (e.g. content or summary) field treat tags as text
@@ -206,8 +208,6 @@ class MagpieRSS {
                }
        }
 
-
-
        function feed_cdata ($p, $text) {
 
                if ($this->feed_type == ATOM and $this->incontent)
@@ -247,7 +247,7 @@ class MagpieRSS {
                }
                elseif ($this->feed_type == ATOM and $this->incontent  ) {
                        // balance tags properly
-                       // note:  i don't think this is actually neccessary
+                       // note: This may not actually be necessary
                        if ( $this->stack[0] == $el )
                        {
                                $this->append_content("</$el>");
@@ -426,7 +426,7 @@ function fetch_rss ($url) {
        else {
                // Flow
                // 1. check cache
-               // 2. if there is a hit, make sure its fresh
+               // 2. if there is a hit, make sure it's fresh
                // 3. if cached obj fails freshness check, fetch remote
                // 4. if remote fails, return stale object, or error
 
@@ -436,7 +436,6 @@ function fetch_rss ($url) {
                        debug($cache->ERROR, E_USER_WARNING);
                }
 
-
                $cache_status    = 0;           // response of check_cache
                $request_headers = array(); // HTTP headers to send with fetch
                $rss                     = 0;           // parsed RSS object
@@ -541,7 +540,7 @@ endif;
  * @return Snoopy style response
  */
 function _fetch_remote_file($url, $headers = "" ) {
-       $resp = wp_remote_request($url, array('headers' => $headers, 'timeout' => MAGPIE_FETCH_TIME_OUT));
+       $resp = wp_safe_remote_request( $url, array( 'headers' => $headers, 'timeout' => MAGPIE_FETCH_TIME_OUT ) );
        if ( is_wp_error($resp) ) {
                $error = array_shift($resp->errors);
 
@@ -580,8 +579,8 @@ function _fetch_remote_file($url, $headers = "" ) {
  * @package External
  * @subpackage MagpieRSS
  *
- * @param unknown_type $resp
- * @return unknown
+ * @param array $resp
+ * @return MagpieRSS|bool
  */
 function _response_to_rss ($resp) {
        $rss = new MagpieRSS( $resp->results );
@@ -725,7 +724,7 @@ class RSSCache {
        Function:       set
        Purpose:        add an item to the cache, keyed on url
        Input:          url from wich the rss file was fetched
-       Output:         true on sucess
+       Output:         true on success
 \*=======================================================================*/
        function set ($url, $rss) {
                $cache_option = 'rss_' . $this->file_name( $url );
@@ -935,5 +934,3 @@ function get_rss ($url, $num_items = 5) { // Like get posts, but for RSS
        }
 }
 endif;
-
-?>