README

Members add their birthday and choose what others see. The forum shows it on their profile, puts a cake next to their name on the day, lists who celebrates this week, and wishes them a happy birthday.

Install

composer require datlechin/flarum-birthdays

Enable Birthdays under Admin > Extensions. Needs Flarum 2.0 and PHP 8.2.

Then grant View birthdays to the groups that should see them, usually Members. Until you do, only admins see other members' birthdays.

What members see

On a profile

The birthday, the age, or both, depending on what the member shows:

Show my birthday	Show my age	Others see
On	On	Birthday October 27, age 36
On	Off	Birthday October 27
Off	On	Age 36
Off	Off	Nothing

The year is never shown on its own. Only the member and moderators who can edit them see the full date.

A badge

On the day, a cake badge sits next to the member's name on their profile and their posts.

The Birthdays page

Linked from the sidebar. It lists who celebrates today and in the next seven days, grouped by day. Members who hide their birthday are left out.

A greeting

On their birthday, members get a "happy birthday" notification. They can turn it off in their notification settings, like any other notification.

What members set

In Settings:

Account > Add Birthday (or Change Birthday) sets or clears the date.
Privacy > Show my birthday on my profile and Show my age on my profile. New members start with the birthday shown and the age hidden.

Moderators can set a member's birthday from the Edit User dialog.

Settings

Admin > Extensions > Birthdays.

Setting	Default	What it does
Birthday at sign-up	Don't ask	Don't ask, ask and allow skipping, or ask and require it.
Minimum age	13	Checked every time a birthday is saved. At 0, only dates in the future are refused.

Dates follow the forum language. To change how they are written, override the keys under datlechin-birthdays.lib.datetime_formats in a language pack or with Linguist.

Permissions

Permission	Default	Allows
View birthdays	Admins only	Seeing what members chose to show, and the Birthdays page.
Edit own birthday	Members	Setting and clearing your own birthday.

The Birthdays page lists users, so it also needs core's Search users permission.

Moderators who can edit a user can also see and change that user's full birthday.

The greeting

php flarum birthdays:notify sends it. It runs once a day through the Flarum scheduler, so the scheduler's cron entry must be set up. It uses the server's date, and running it twice on the same day sends nothing new.

Members born on February 29 are greeted and listed on February 28 in other years.

Update

composer update datlechin/flarum-birthdays
php flarum migrate
php flarum cache:clear

Updating from 3.0.0-beta.1, or from 2.x along with Flarum itself, keeps every birthday and each member's choices. The changelog lists what changed.

For extension authors

User attributes in the API:

Attribute	Sent to	Value
`birthday`	The member, and those who can edit them. Writable by the same people.	`YYYY-MM-DD` or `null`
`birthMonthDay`	Anyone with View birthdays, when the member shows their birthday	`MM-DD`
`age`	Anyone with View birthdays, when the member shows their age	Integer
`showBirthday`, `showAge`	The member, and those who can edit them. Writable.	Boolean
`canEditBirthday`	Everyone	Boolean

The forum resource has canViewBirthdays.

To list users by the day they celebrate, pass a date or a range of up to 31 days. Results come soonest first:

GET /api/users?filter[birthday]=2026-10-27
GET /api/users?filter[birthday]=2026-12-29..2027-01-04

The notification type is birthday, with the member as its subject.

datlechin / flarum-birthdays

Package info

Security

Fund package maintenance!

Statistics