FoF SEO
A Flarum extension that adds SEO tags to your forum — meta description, Open Graph, Twitter cards, and schema.org structured data.
Documentation
Full documentation lives in the docs/ folder:
Installation
composer require fof/seo:"^3"
Updating
composer update fof/seo
php flarum cache:clear
Migrating from v17development/flarum-seo
This extension was transferred to FriendsOfFlarum and was previously published as v17development/flarum-seo. The FriendsOfFlarum line begins at 3.0.0, continuing the version history (the previous package reached 2.0.9).
For forum admins, migration is a one-line change — swap the package, keep your settings and stored SEO data:
composer remove v17development/flarum-seo
composer require fof/seo:"^3"
php flarum cache:clear
fof/seo declares replace: { "v17development/flarum-seo": "*" }, so anything that depended on the old package is satisfied by the new one, and the two can never be installed at once. Existing v17development/flarum-seo releases (≤ 2.0.9) remain installable from Packagist for anyone not yet ready to switch.
Third-party extension authors should update any references from the V17Development\FlarumSeo namespace to FoF\Seo, and from the v17development-seo frontend module to fof-seo. See the developer documentation.
Features
SEO tags are generated for the following pages:
- Home page
- Tags page (if
flarum/tags is enabled)
- Discussion page
- User profile
- Pages page (if
fof/pages is enabled)
Methods used:
- HTML meta tags (
application-name, description, keywords, language)
- Open Graph tags (
og:type, og:title, og:description, og:url, article:published_time, article:updated_time)
- Twitter cards
inLanguage on every page- Schema.org structured data:
- Uses the first image in the post as the social-media image when one is present, falling back to the configured default.
Works with
Compatible — but not required — alongside:
Extending
Third-party extensions have three integration points:
- Page drivers — emit/replace structured data for your own routes by extending
FoF\Seo\Extend\SEO and implementing FoF\Seo\Page\PageDriverInterface.
SeoMeta objects — give your own models managed, per-object metadata that appears in the Configure SEO dialog.- The
PreparingPageMeta event — intercept and override the prepared metadata (language, description, any schema.org property) on any page.
See the developer guides for details:
Credits
This extension was originally created and maintained by V17 Development as v17development/flarum-seo. FriendsOfFlarum is grateful for their work bringing SEO support to the Flarum ecosystem and continues development with their blessing.
Links
License
This extension is licensed under the MIT License. See the LICENSE.md file for details.
