User Tools

Site Tools


res:plugins:entrylist

This is an old revision of the document!


Entrylist

Author: Piero VDFN

Description

The plugin adds the BBCode tag entrylist. It requires the BBCode plugin and allows you to list blog entries grouped by their entry date (year → month → day → entries).

Tip:
The plugin does not include a widget. However, you can create a static page and then use the BlockParser plugin to place it as a widget in the menu column.

Usage

Basic syntax:

[entrylist <options>]

You can filter by year/month/day:

  • y filters by year
  • m filters by month (requires y)
  • d filters by day (requires y and m)

If no filter is given, the plugin outputs a hierarchical archive list (years → months → days → entries).

Parameters

Parameter Values Description
y YY or YYYY List entries for a year. YY means 2000–2099 (e.g. 23 = 2023). YYYY is accepted for convenience in the range 2001–2099 (e.g. 2025).
m MM or M List entries for a month. Requires y. Values 1–12 (1 will be treated as 01).
d DD or D List entries for a day. Requires y and m. Values 1–31 (2 will be treated as 02). Invalid dates (e.g. 31/02) return “no entries”.
yformat date format Output format for year headings (strftime-style tokens). Overrides default.
mformat date format Output format for month headings (strftime-style tokens). Overrides default.
dformat date format Output format for day headings (strftime-style tokens). Overrides default.
link on/off (also false) Whether entry titles should link to the entry. Default: on. Use off or false to disable.
sort asc/desc Sorting order. Default: asc. Applies to years/months/days and also to entries within a day (by entry id / time).
noentries text If the resulting list is empty, output this text instead.

Date & time formats (important)

FlatPress allows admins to configure the site short date format under:
Administration → Configuration → International settings.

Default behaviour (version 1.0.4):

  • Day headings use the configured admin date format (locale.dateformatshort) as-is.
  • Month and year headings are automatically derived from that admin short date format.
  • You can override these defaults per tag with yformat/mformat/dformat.

This means the Entrylist headings follow the admin-configured formats for many locales (e.g. German, English, Spanish, French, Italian, Greek, Dutch, Danish, Czech, Japanese, Portuguese/Brazil, Russian, Turkish, …), including formats with literal characters like 年/月/日.

Examples

Entrylist for the whole year 2023

[entrylist y=23]

Same year, using a 4-digit year

[entrylist y=2023]

If there is no entry in the whole year 2024, output “none at home”

[entrylist y=24 noentries="none at home"]

Entrylist only for January 2023

[entrylist m=01 y=23]

Entrylist only for day 12 of January 2023

[entrylist d=12 m=01 y=23]

Same day, but without links to the posts

[entrylist d=12 m=01 y=23 link=off]

Descending order

[entrylist y=23 sort=desc]

Override heading formats

[entrylist y=23 yformat="%Y" mformat="%B %Y" dformat="%A, %e. %B %Y"]

Override the entry time format (per tag)

[entrylist=+%H:%M y=23]

Overwrite heading and entry time (v1.0.3 like)

[entrylist=+%H:%M y=23 yformat="%Y" mformat="%B" dformat="%d"]

Notes

  • The list is built from FlatPress entries and grouped by their entry date (the date stored in the entry id).
  • The plugin uses a cache file (plugin_entrylist_tag.txt in FlatPress' cache directory) and automatically invalidates it when entries are published or deleted.

Screenshots

Preview version 1.0.3 Preview version 1.0.4

License

GNU GPLv2

Download

Git Repo

github repo of Entrylist plugin

Changelog

2026-01-05: Version 1.0.4
  • Respects the admin-configured short date format
  • Accepts 4-digit years (2001–2099) in addition to YY
  • Per-tag state reset: multiple [entrylist] tags on one page no longer affect each other
2026-01-03: Version 1.0.3
  • With time of creation of the post
2025-02-26: Version 1.0.2
  • Compatibility with PHP 8.0+ established

Support
Please ask for help on the FlatPress Forum.

res/plugins/entrylist.1767660220.txt.gz · Last modified: by fraenkiman

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki