README

This extension adds a new bbcode which will display predefined messages created by an administrator. The messages can be updated anytime in the admin panel and will immediately reflect the new content on the forum.

Installation

Use Bazaar or install manually:

composer require flagrow/canned-messages

Updating

composer update flagrow/canned-messages
php flarum migrate
php flarum cache:clear

Configuration

You can add new messages under the "Canned Messages" tab of the admin panel. Each message has a unique key that must be inserted along with the bbcode. You can define a different content for different locales. The script will first try to find a message for the given key and locale, then the given key and no locale, and fallbacks to a default text if no message is found.

By default the extension uses the [CANNED-MESSAGE] bbcode, but you can change it to something else in the "advanced settings". Keep in mind this will break all existing canned messages using a different tag. If you want to use a custom tag name, better set it early.

Make sure to clear the forum cache with php flarum cache:clear and your browser cache after changing the tag name.

There are currently no usage permissions. Anybody can use any of the message keys in their posts.

Messages are not secret, the full list is loaded with the forum in order to provide the live preview. Anybody with knowledge of the Flarum data store can read the list of existing messages.

Support our work

We prefer to keep our work available to everyone. In order to do so we rely on voluntary contributions on Patreon.

Security

If you discover a security vulnerability within Canned Messages, please send an email to the Gravure team at security@gravure.io. All security vulnerabilities will be promptly addressed.

Please include as many details as possible. You can use php flarum info to get the PHP, Flarum and extension versions installed.

Links

An extension by Flagrow, a project of Gravure.

flagrow / canned-messages

Maintainers

Details