README

A Flarum extension that allows you to add links to your forum's navigation.

Features

• Add links to your forum's navigation menu
• Support for both internal and external links
• Control link visibility based on user groups
• Guest-only links
• Hierarchical links (dropdown menus)
• Programmatic link definition via PHP

Installation

Install with composer:

composer require fof/links

Updating

composer update fof/links
php flarum cache:clear

Usage

Admin Interface

Links can be managed through the admin interface under the "Links" tab.

Programmatic Link Definition

This extension provides a way to define links programmatically through PHP code. This can be useful in situations where there are multiple environments (ie dev, staging, production) and you want to define a set of links only once (in code), and not have to re-enter or define them via the admin interface.

Basic Usage

use FoF\Links\Extend\LinksOverride;
use FoF\Links\LinkDefinition;

return [
    // Other extenders...
    
    (new LinksOverride())
        ->addLinks([
            LinkDefinition::make()
                ->withId(1)
                ->withTranslationKey('my-extension.link')
                ->withUrl('/my-page')
                ->withIcon('fas fa-link')
                ->withIsInternal(true)
        ])
];

Hierarchical Links

You can create dropdown menus by adding child links:

use FoF\Links\Extend\LinksOverride;
use FoF\Links\LinkDefinition;

$parent = LinkDefinition::make()
    ->withId(1)
    ->withTranslationKey('my-extension.parent')
    ->withUrl('/parent');

$child1 = LinkDefinition::make()
    ->withId(2)
    ->withTranslationKey('my-extension.child1')
    ->withUrl('/child1');

$child2 = LinkDefinition::make()
    ->withId(3)
    ->withTranslationKey('my-extension.child2')
    ->withUrl('/child2');

$parent->addChild($child1);
$parent->addChild($child2);

return [
    // Other extenders...
    
    (new LinksOverride())
        ->addLinks([$parent])
];

Using a Provider Class

For more complex scenarios, you can use a provider class:

use FoF\Links\Extend\LinksOverride;
use FoF\Links\LinkDefinition;

class MyLinksProvider
{
    public function __invoke()
    {
        return [
            LinkDefinition::make()
                ->withId(1)
                ->withTranslationKey('my-extension.link')
                ->withUrl('/my-page')
        ];
    }
}

return [
    // Other extenders...
    
    (new LinksOverride())
        ->addLinks(MyLinksProvider::class)
];

LinkDefinition API

The LinkDefinition class provides a fluent interface for defining links:

Links

• Packagist
• GitHub
• Discuss

An extension by FriendsOfFlarum.