WordPress 4.5
[autoinstalls/wordpress.git] / wp-includes / class-feed.php
index 919440f18e87a93add1b745f53c319e85c2aaa0d..f0ae19633dd6bfd0afcadfa9b052214cf1309e73 100644 (file)
@@ -9,6 +9,11 @@ class WP_Feed_Cache extends SimplePie_Cache {
         *
         * @static
         * @access public
+        *
+        * @param string $location  URL location (scheme is used to determine handler).
+        * @param string $filename  Unique identifier for cache object.
+        * @param string $extension 'spi' or 'spc'.
+        * @return WP_Feed_Cache_Transient Feed cache handler object that uses transients.
         */
        public function create($location, $filename, $extension) {
                return new WP_Feed_Cache_Transient($location, $filename, $extension);
@@ -20,6 +25,13 @@ class WP_Feed_Cache_Transient {
        public $mod_name;
        public $lifetime = 43200; //Default lifetime in cache of 12 hours
 
+       /**
+        * Class instantiator.
+        * 
+        * @param string $location  URL location (scheme is used to determine handler).
+        * @param string $filename  Unique identifier for cache object.
+        * @param string $extension 'spi' or 'spc'.
+        */
        public function __construct($location, $filename, $extension) {
                $this->name = 'feed_' . $filename;
                $this->mod_name = 'feed_mod_' . $filename;
@@ -38,6 +50,9 @@ class WP_Feed_Cache_Transient {
 
        /**
         * @access public
+        *
+        * @param SimplePie $data Data to save.
+        * @return true Always true.
         */
        public function save($data) {
                if ( $data instanceof SimplePie ) {