https://github.com/statamic/plugin-simplepie
A fast and easy-to-use RSS and Atom feed parsing plugin for Statamic.
https://github.com/statamic/plugin-simplepie
Last synced: 3 months ago
JSON representation
A fast and easy-to-use RSS and Atom feed parsing plugin for Statamic.
- Host: GitHub
- URL: https://github.com/statamic/plugin-simplepie
- Owner: statamic
- Created: 2012-06-22T03:31:20.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2018-09-13T00:11:06.000Z (almost 7 years ago)
- Last Synced: 2025-03-22T04:41:27.246Z (3 months ago)
- Language: PHP
- Homepage: http://statamic.com
- Size: 64.5 KB
- Stars: 13
- Watchers: 11
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Statamic SimplePie Plugin 
================================
The SimplePie plugin is a fast and easy-to-use RSS and Atom feed parser.
## Installing
1. Download the zip file (or clone via git) and unzip it or clone the repo into `/_add-ons/`.
2. Ensure the folder name is `simplepie` (Github timestamps the download folder).
3. Enjoy.
## Example Tag
{{ simplepie url="http://statamic.com/blog/feed" limit="5" cache="yes" }}
{{ title }}
Posted on {{ date }}
{{ content }}
{{ /simplepie }}
## Parameters
### URL `url`
The URL of the feed to be parsed.
url="http://statamic.com/blog/feed/"
### Order By Date `order_by_date`
**default:** yes
Order by date or default feed order.
### Limit `limit`
**Default:** 10
Limit the number of items returned.
### Offset `offset`
**Default:** 0
Offset the returned items. For example, if your feed returns
- Mustaches
- Corncob Pipes
- Musky Scent
Setting `offset="1"` would return:
- Corncob Pipes
- Musky Scent
### Cache `cache`
**Default:** no
Turn caching on for faster page loads or to limit API/Feed requests.
### Timeout `timeout`
**Default:** 10 (seconds)
The maximum number of seconds to spend waiting to retrieve a feed.
## Variables
Upon successfully retrieving a feed, the following default variables become available inside the `{{ simplepie }}` tag pair.
- {{ title }}
- {{ permalink }}
- {{ date }}
- {{ update_date }}
- {{ author }}
- {{ category }}
- {{ description }}
- {{ content }}