Download the PHP package bnomei/kirby3-feed without Composer
On this page you can find all versions of the php package bnomei/kirby3-feed. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bnomei/kirby3-feed
More information about bnomei/kirby3-feed
Files in bnomei/kirby3-feed
Package kirby3-feed
Short Description Generate a RSS/JSON/Sitemap-Feed from a Pages-Collection
License MIT
Informations about the package kirby3-feed
Kirby 3 Feed and Sitemap
Generate a RSS/JSON/Sitemap-Feed from a Pages-Collection.
Commercial Usage
Support open source!
This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?
Be kind. Share a little. Thanks.
‐ Bruno
M | O | N | E | Y |
---|---|---|---|---|
Github sponsor | Patreon | Buy Me a Coffee | Paypal dontation | Hire me |
Similar Plugins
both have not seen any updates since April 2019
Installation
- unzip master.zip as folder
site/plugins/kirby3-feed
or git submodule add https://github.com/bnomei/kirby3-feed.git site/plugins/kirby3-feed
orcomposer require bnomei/kirby3-feed
Usage Feed
You can use this in a template for a dedicated feed page, in a template controller or a route.
options array defaults
If you use these defaults you need to provide the fields date (type: date)
and text (type: text)
.
virtual page in site/config/config.php
HTML head element
rss xml
and/or rss json
TIP: Having multiple feed links is still valid html. So you can have both rss and json if you want and setup the routes properly.
Sorting
The Plugin applies a default sorting for the pages by date/modified in descending order (newest first).
- If you do not want this you have to set the
datefield
setting to another Field name or PageMethod name. - If you want to disable sorting by the plugin and add your own you can set the option
sort
tofalse
.
Pitfalls when presorting by date and limit
Using sortBy('date', 'desc')
will not yield expected results! In K3 sorting by date needs a callback.
Usage Sitemap
options array defaults
If you use these defaults you need to provide the fields date (type: date)
and text (type: text)
.
virtual page in site/config.php
example for excluding pages from sitemap
see Kirby Docs -Filtering compendium
Settings
bnomei.feed. | Default | Description |
---|---|---|
mime | null |
to autodetect json or rss-xml otherwise enforce output with a certain MIME type (one of the extensions defined in Kirby's Mime class, e.g. value xml to enforce text/xml ) |
expires | 60*24*7 |
in minutes |
The plugin will automatically devalidate the cache if any of the Page-Objects were modified.
Cache
If the global debug option is set to true
the plugin will automatically flush its own cache and not write to the cache.
Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.
License
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.
Credits
based on K2 versions of