- Price: 10 USD lifetime license
- Bundled translations: English
- Flarum compatibility: 1.2+
- See and purchase on Extiverse
- See on Flarum Discuss
Table of content:
Introduction
Custom Paths is a Flarum extension that allows you to customize the URL to various user-facing pages.
When a path is customized, the original URL returns a 404 error. You can optionally enable redirects from the old paths to the new paths.
The screenshot below is outdated and only shows a subset of the settings available in the latest version.
Changelog
Version 1.9.0 - June 25, 2023
- Fix user profile prefix not applying to new security page from Flarum 1.7.
- Enable customization of security page suffix.
- Enable customization of FoF Masquerade profile page.
- Enable customization of FoF Moderator Notes profile page.
- Enable customization of v17development’s User Badges pages.
- Sync user profile prefix in KILOWHAT Cimaise. Suffix and other pages customization will be added in a future update.
Version 1.8.0 - September 13, 2022
- Add ability to customize Flarum 1.5 profile likes page.
- Add ability to customize ClarkWinkelmann’s Composer Page pages.
- Add ability to customize Formulaire profile page.
- Fix renamed profile tabs that were redirecting to the homepage instead of their intended new name.
The extension was confirmed working on Flarum 1.5.
Show older releases
Version 1.7.0 - August 17, 2022
- Add ability to customize FoF Gamification user votes page.
- Add ability to customize ClarkWinkelmann’s Discussion Bookmarks page.
- Add ability to customize ClarkWinkelmann’s Post Bookmarks page.
- Add ability to customize ClarkWinkelmann’s Discussion Lists pages.
Discussion Lists does not yet have any production-ready release, support was added for internal testing with clients.
This version requires Flarum 1.2 or greater.
Version 1.6.0 - August 27, 2021
- Add ability to customize Flamarkt pages.
Flamarkt does not yet have any production-ready release, support was added for internal testing with clients.
Version 1.5.0 - June 9, 2021
- Flarum 1.0+ compatibility.
This version can be installed on Flarum 1.0.0 and all future 1.x versions. It will be automatically installed when you upgrade to Flarum 1.0 by following the official release guide.
Version 1.4.0 - March 23, 2021
- Flarum beta 16 compatibility.
This version can only be installed on Flarum beta 16 and will automatically be installed when you migrate to Flarum beta 16 with Flarum’s official instructions.
Version 1.3.0 - February 27, 2021
- Add ability to customize v17development’s Flarum Blog pages.
- Add ability to customize FriendsOfFlarum’s Byobu pages.
- Add ability to customize ClarkWinkelmann’s Group List page.
- Fix v17development’s SEO inability to add SEO tags to customized pages.
- Fix issue when setting a customized page as homepage.
Version 1.2.0 - January 18, 2021
- Add ability to customize Formulaire standalone form and submission URLs.
Version 1.1.0 - December 27, 2020
- Flarum beta 15 compatibility.
- Add ability to customize FoF Gamification rankings page.
- Add ability to customize the user profile page filters (
/discussions,/mentions). - Add ability to re-use paths.
This version can only be installed on Flarum beta 15 and will automatically be installed when you migrate to Flarum beta 15 with Flarum’s official instructions.
Version 1.0.3 - November 3, 2020
- Flarum beta 14 compatibility.
- Fix
/u/<username>/mentionsnot being affected by the/u/customization.
This version can only be installed on Flarum beta 14 and will automatically be installed when you migrate to Flarum beta 14 with Flarum’s official instructions.
Version 1.0.2 - May 22, 2020
- Fix issues with loading order.
Version 1.0.1 - May 20, 2020
- Fix issues with original paths that include variables.
Version 1.0.0 - May 20, 2020
Initial release.
Compatibility
Custom Paths provides integration with the following extensions:
An empty column means every version of the extension is supported by every version of Custom Paths.
| Extension | Extension version required | Custom Paths version required |
|---|---|---|
| Flarum’s Tags | ||
| Flarum’s Subscriptions | ||
| Flarum’s Flags | ||
| Flarum’s Mentions | 1.1+ | |
| KILOWHAT Formulaire | 1.2+ | |
| FriendsOfFlarum’s User Directory | ||
| FriendsOfFlarum’s Pages | ||
| FriendsOfFlarum’s Gamification | Rankings 1.1+ Votes 1.6+ | |
| FriendsOfFlarum’s Byobu | 1.3+ | |
| FriendsOfFlarum’s Masquerade | 1.9+ | |
| FriendsOfFlarum’s Moderator Notes | 1.9+ | |
| Askvortsov’s Categories | ||
| v17development’s Flarum Blog | 1.3+ | |
| v17development’s User Badges | 1.9+ | |
| ClarkWinkelmann’s Group List | 1.3+ | |
| ClarkWinkelmann’s Discussion Bookmarks | 2.0+ | 1.7+ |
| ClarkWinkelmann’s Post Bookmarks | 1.7+ | |
| ClarkWinkelmann’s Discussion Lists | 1.7+ | |
| ClarkWinkelmann’s Composer Page | 1.8+ | |
| Flamarkt (not yet released) | Beta 1 | 1.6+ |
The following extensions are/were incompatible:
- v17development’s SEO: Discussion and Profile URLs are not modified in meta tags, which will likely cause negative SEO effect. This is a problem in the SEO extension where all URLs have been hard-coded and don’t support route renames nor custom slug drivers.
- FriendsOfFlarum’s Sitemap 1.x only. Discussion, Tag and Profile URLs were not modified in sitemap. Those issues are resolved in version 2.0 of Sitemap.
Most other Flarum extensions should work fine alongside Custom Paths, but no integration will be automatically provided.
You may request additional integrations on the Discuss page.
Known issues
- The eye icon in the FoF Pages admin panel won’t open the correct URL if it was customized, but the customized path is correctly applied. (the original path is hard-coded in the admin panel)
Issues in previous versions that have been fixed as of 1.1.0:
- The URLs in emails won’t be updated. You can use FriendsOfFlarum’s Pretty Mail with a custom HTML template to correct the URL.
- You can’t re-use an existing path, like
/d/or/allor/settingsor others anytime,/t/or/tagswhen the Tags extension is enabled, or/p/when the Pages extension is enabled. - The “Following” link in the side navigation doesn’t have an “active” effect when the page is displayed if the path has been customized.
- The Flags page can’t be loaded or redirected when typing the URL directly. This is a bug in Flarum, see flarum/flags#23.
Issues that have been fixed as of 1.3.0:
- v17development’s SEO was not able to add SEO tags to pages with customized URLs. The meta tags still contain incorrect hard-coded URLs.
Issues in previous versions that have been fixed as of 1.8.0:
- The user profile filters (
/discussions,/mentionssuffix) were not affected by the “Redirect” setting. Typing the old URL would always redirect to the homepage.
Installation
- Purchase the “KILOWHAT Custom Paths” extension via the Extiverse website
- If this is your first premium extension purchase from Extiverse, follow the “Composer configuration” instructions available at https://extiverse.com/premium/subscriptions
- Install the extension via Composer:
composer require kilowhat/flarum-ext-custom-paths - Open the Flarum admin panel and enable the extension
- See below for the settings
Update
When an update is available, the Changelog will be updated above and a message will be posted on the Flarum Discuss discussion.
You can use the following commands to update:
composer require kilowhat/flarum-ext-custom-paths
php flarum migrate
php flarum cache:clear
Support
If you are having issues with the extension, check the following:
- If the extension doesn’t install, check you have correctly configured Extiverse’s private repository.
- If an error happens during activation or usage of the extension, check the logs in
<flarum>/storage/logs.
If you are still having issues, please copy the output of the logs above, as well as the output of php flarum info and send an email to [email protected].
Support is provided on a “best effort” basis. Most replies should usually be within 24h.
I only provide help solving specific issues with the extension. I won’t install the extension for you.
Extension settings
All settings can be found in the extension page of the admin panel.
You don’t need to install/enable all the compatible extensions. Only the paths for your enabled extensions will be customizable.
Paths
Each of the paths can be customized by entering an alternate path segment in the text field, then saving with the button at the bottom of the page.
Be careful with path re-use. Since version 1.1.0, you can re-use tokens that were part of other URLs in new paths. For example you can use /t/ (originally for tags) for discussions, provided you set the tags path to something different. The extension will not check for duplicated paths, but Flarum won’t work correctly if you use the same path twice.
There is no data validation, but for optimal compatibility with browsers you should only use the following:
- Use alphanumerical values and dashes/underscores (A-Za-z0-9_-).
- There is no maximum length, but it’s probably a good idea to remain below 50 characters.
- Minimum length is 1 character. It’s not possible to use an empty path segment.
If you leave a field empty, the default path will be kept.
Redirects
By default, the original URL of modified paths will return a 404 page not found error. By enabling “Redirect default Flarum paths to new paths”, a redirect to the new path will be returned instead.
- With debug mode enabled, a 302 temporary redirect is used.
- With debug mode disabled, a 301 permanent redirect is used.
Renamed profile page tabs are redirected with javascript instead of HTTP redirects due to their routing happening client-side.