bnomei / kirby3-recently-modified
Kirby 3 Section to display recently modified content pages
Fund package maintenance!
bnomei
Patreon
buymeacoff.ee/bnomei
paypal.me/bnomei
Installs: 1 160
Dependents: 0
Suggesters: 0
Security: 0
Stars: 19
Watchers: 2
Forks: 0
Open Issues: 0
Type:kirby-plugin
Requires
README
Kirby 3 Plugin to view recently modified pages by current User
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 |
Installation
- unzip master.zip as folder
site/plugins/kirby3-recently-modified
or git submodule add https://github.com/bnomei/kirby3-recently-modified.git site/plugins/kirby3-recently-modified
orcomposer require bnomei/kirby3-recently-modified
Screenshot
Section
Field
Usage
Add the section to your site or page blueprint.
site/blueprints/site.yml
sections: listPagesModifiedByUser: type: recentlymodified headline: Your Recently Modified Pages # query
Optionally you can add the field to page blueprints to show the time and user that modified given page most recently.
site/blueprints/default.yml
fields: showWhichUserModifiedPage: type: recentlymodified label: Recently Modified By # interval: 60
⚠️ This plugin has by default a 1 minute cache.
Query for the Section (not Field)
The plugins section comes with a default query that shows the most recent changes made by the currently logged in user. But you can define any other query you like.
Default Query
site.index(true).sortBy('modified', 'desc').onlyModifiedByUser
onlyModifiedByUser
is a pagesmethod added by this plugin that filters the pages collection to only those pages that where modified by the currently logged in user. The plugin uses hooks to track what pages each user did edit.
Example 1
sections: recentarticles: type: recentlymodified headline: Recently Modified Articles query: site.find('articles').children.listed.sortBy('modified', 'desc')
Example 2
sections: mycollection: type: recentlymodified headline: My Collection query: kirby.collection('my-collection')
return [ 'bnomei.recently-modified.limit' => 25, 'bnomei.recently-modified.info' => function ($page) { return $page->id(); }, // other options... ];
TIP: You could use the
query
property,info
andlimit
setting to show any list of pages you want. Just like simplified version of the pagetable plugin.
Known Limitations
- You can not set multiple
text
/link
/info
settings. All instances of therecentlymodified
section share the same. - The
limit
setting is always applied. If you want some of your instances to have a smaller number of items then calllimit
inside your custom query.
Settings
bnomei.recently-modified. | Default | Description |
---|---|---|
query | ... |
see above |
link | function($page){...} |
callback to return the link |
text | function($page){...} |
callback to return the text |
info | function($page){...} |
callback to return the info |
format | Y/m/d H:i:s |
date format string |
hooks | true |
use hooks to track users modified pages |
limit | 7 |
limit list and cache items |
expire | 1 |
cache will expire n-minutes |
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.