PHPackages adspectus/feedreader - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. adspectus/feedreader ActiveKirby-plugin[Utility & Helpers](/categories/utility) adspectus/feedreader ==================== Kirby 3 plugin to show feeds v1.1.2(4y ago)47[1 issues](https://github.com/Adspectus/k3-feedreader/issues)GPL-3.0-or-laterPHP Since Aug 2Pushed 4y ago1 watchersCompare [ Source](https://github.com/Adspectus/k3-feedreader)[ Packagist](https://packagist.org/packages/adspectus/feedreader)[ RSS](/packages/adspectus-feedreader/feed)WikiDiscussions master Synced 1w ago READMEChangelogDependencies (1)Versions (4)Used By (0) k3-feedreader ------------- [](#k3-feedreader) [![GitHub tag (latest by date)](https://camo.githubusercontent.com/2b2e967e1539d9cf49c4333eb05d39014d912ece768a76a4a40af81083a6fd52/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f7461672f4164737065637475732f6b332d666565647265616465723f7374796c653d666c61742d737175617265266c6162656c3d56657273696f6e)](https://github.com/Adspectus/k3-feedreader/releases)[![GitHub issues](https://camo.githubusercontent.com/db0b20b8cbfab50dc26ac88011558836596eea39bcfe7cba8ef363851ca86296/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f4164737065637475732f6b332d666565647265616465723f7374796c653d666c61742d737175617265266c6162656c3d497373756573)](https://github.com/Adspectus/k3-feedreader/issues)[![GitHub license](https://camo.githubusercontent.com/044b518cca64d9df82c7dc938a7f3f95dec43aa1c15289713a6bf3e7bbeea092/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f4164737065637475732f6b332d666565647265616465723f6c6162656c3d4c6963656e7365267374796c653d666c61742d737175617265)](https://github.com/Adspectus/k3-feedreader/blob/master/LICENSE)[![Kirby version](https://camo.githubusercontent.com/aceac14a01f6563b1b4396064dc7239357de8ceada9234caec9d8f8f22299dd1/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6c6162656c3d4b69726279266d6573736167653d3326636f6c6f723d79656c6c6f77267374796c653d666c61742d737175617265)](https://getkirby.com/)[![PHP version](https://camo.githubusercontent.com/1d25d3d9a9432f34fd75bf0c87a5b30de8b575849dc6fc5f80110fc1f3a7a914/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6c6162656c3d504850266d6573736167653d372e3325324226636f6c6f723d383839326266267374796c653d666c61742d737175617265)](https://php.net/) Kirby 3 plugin to show feeds. The FeedReader plugin provides an unified access to the elements of a feed. A feed might be of type RSS, Atom or JSON and is accessed by its URL. A snippet and a blocks blueprint are provided as a starting point. Getting Started --------------- [](#getting-started) ### Prerequisites [](#prerequisites) - Kirby 3 ### Dependencies [](#dependencies) - `Kirby\Cache\Cache` - `Kirby\Http\Remote` - `Kirby\Toolkit\Xml` ### Installation [](#installation) You can install this plugin via one of the following methods: 1. Composer ``` composer require adspectus/feedreader ``` 2. Manual Clone this repository or download the current release and extract at least the files `index.php` and `index.js`, as well as the directories `lib`, `blueprints`, and `snippets` into a new folder `site/plugins/k3-feedreader` of your Kirby installation. Basic Usage ----------- [](#basic-usage) The basic usage is to import the `FeedReader` class and create a new `FeedReader` object out of it anywhere in your template or snippet. The URL of the feed must be given as first and possibly only parameter: ``` use Adspectus\FeedReader\FeedReader; $feed = new FeedReader('https://www.heise.de/security/rss/news.rdf'); ``` In case the URL is valid and can be successfully retrieved, the content of the feed is accessible through various methods of the instance of the `FeedReader` object which is now stored in the `$feed` variable (see [Reference](doc#reference) for a full description of all methods). ### Errors [](#errors) If something went wrong during the creation of the object, the error message(s) will be saved and is/are accessible by the `error()` method. Just check if the return value of `error()` is empty or not. If it is not empty, the error(s) will be returned as an array. Hence ``` if (! empty($feed->error())) { dump($feed->error()); /* or var_dump($feed->error()) */ } ``` will show you the error(s). If you need more information about the `FeedReader` object - irrespective of an error - you can dump it by the `debug()` method. This method returns all properties of the `FeedReader` object as an array: ``` dump($feed->debug()); /* or var_dump($feed->debug()) */ ``` See [Debugging](doc#debugging) in the docs how you can extend or limit the amount of information this method returns. Of course, it would be wise to output the value of both methods only when the global debug option of Kirby is set to `true`. Otherwise, you may confront your website visitors with strange and bizarre messages. ### Options [](#options) The plugin makes use of Kirby's caching mechanism. You can disable this by setting the key/value pair ``` `adspectus.feedreader.cache` => false ``` in the `return` statement of your `config.php`. See [Caching](doc#caching) in the docs how caching works in this plugin. Extended Usage -------------- [](#extended-usage) This plugin comes with a blocks blueprint and a corresponding snippet to work with Kirby's panel. See [Extended Usage](doc#extended-usage) in the docs how you can use and adapt this blueprint and snippet. Contributing ------------ [](#contributing) The plugin has been tested with a variety of feeds. It is, however, almost impossible to take every variation in feed format into account for proper sourcing. If you encounter a feed with which this plugin is not working as intended, open an issue with the feed URL. Of course, you can also clone this repo and provide a fix. License ------- [](#license) [GNU General Public License v3.0](LICENSE) Acknowledgements ---------------- [](#acknowledgements) - [texnixe](https://forum.getkirby.com/u/texnixe/) for code review and tips. ### Health Score 23 — LowBetter than 27% of packages Maintenance15 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community7 Small or concentrated contributor base Maturity53 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~10 days Total 3 Last Release 1729d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/aa23afae96dabbf8ed4a6d48ba81526d31178c93513aeaaffe562f9343b85cdc?d=identicon)[Adspectus](/maintainers/Adspectus) --- Top Contributors [![Adspectus](https://avatars.githubusercontent.com/u/8707493?v=4)](https://github.com/Adspectus "Adspectus (11 commits)") ### Embed Badge ![Health badge](/badges/adspectus-feedreader/health.svg) ``` [![Health](https://phpackages.com/badges/adspectus-feedreader/health.svg)](https://phpackages.com/packages/adspectus-feedreader) ``` ### Alternatives [distantnative/retour-for-kirby Manage redirects and track 404s right from the Kirby CMS Panel 14689.4k1](/packages/distantnative-retour-for-kirby)[mzur/kirby-uniform A versatile Kirby plugin to handle web form actions. 26068.3k13](/packages/mzur-kirby-uniform)[arnoson/kirby-vite Vite helper for Kirby CMS 9759.2k3](/packages/arnoson-kirby-vite)[thathoff/kirby-git-content Plugin to track changes to content in a git repository. 15343.7k](/packages/thathoff-kirby-git-content)[sylvainjule/locator A map & geolocation field, built on top of open-source services / Mapbox 11237.3k1](/packages/sylvainjule-locator)[tobimori/kirby-seo The default choice for SEO on Kirby: Implement technical SEO & Meta best practices with ease and provide an easy-to-use editor experience 10039.7k1](/packages/tobimori-kirby-seo) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)