PHPackages                             tapp/filament-forum - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. tapp/filament-forum

ActiveLibrary[Utility & Helpers](/categories/utility)

tapp/filament-forum
===================

Forum and comments package for Filament apps.

v2.1.2(2mo ago)27752MITPHPPHP >=8.3CI passing

Since Aug 11Pushed 2mo agoCompare

[ Source](https://github.com/TappNetwork/Filament-Forum)[ Packagist](https://packagist.org/packages/tapp/filament-forum)[ RSS](/packages/tapp-filament-forum/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (30)Versions (24)Used By (0)

Filament Forum
==============

[](#filament-forum)

A forum package for Filament apps that provides both admin and frontend resources for managing forums and forum posts.

Requirements
------------

[](#requirements)

- PHP 8.1+
- Laravel 10+
- Filament 4.x/5.x
- Spatie Laravel Media Library

Features
--------

[](#features)

- **Admin Resources**: Full CRUD operations for forums and forum posts
- **Frontend Resources**: User-friendly interface for browsing and participating in forums

Installation
------------

[](#installation)

1. **Require the package via Composer:**

    ```
    composer require tapp/filament-forum
    ```
2. **Publish and run the migrations:**

Warning

If you are using multi-tenancy please see the "Multi-Tenancy Support" instructions below **before** publishing and running migrations.

```
php artisan vendor:publish --tag="filament-forum-migrations"
php artisan migrate
```

3. **Publish the config file:**

    ```
    php artisan vendor:publish --tag="filament-forum-config"
    ```
4. **Register the Plugins:**

    ### Admin Panel (Backend)

    [](#admin-panel-backend)

    Add the admin plugin to your `AdminPanelProvider.php`:

    ```
    use Tapp\FilamentForum\Filament\ForumAdminPlugin;

    public function panel(Panel $panel): Panel
    {
        return $panel
            // ... other configuration
            ->plugins([
                ForumAdminPlugin::make(),
                // ... other plugins
            ]);
    }
    ```

    ### Frontend Panel (User-facing)

    [](#frontend-panel-user-facing)

    Add the frontend plugin to your `AppPanelProvider.php` (or any frontend panel):

    ```
    use Tapp\FilamentForum\Filament\ForumPlugin;

    public function panel(Panel $panel): Panel
    {
        return $panel
            // ... other configuration
            ->plugins([
                ForumPlugin::make(),
                // ... other plugins
            ]);
    }
    ```
5. User model requirements

- Ensure your User model has a `name` attribute
- Add the `ForumUser` trait to your `User` model:

```
use Tapp\FilamentForum\Traits\ForumUser;

class User extends Authenticatable
{
    // ...
    use ForumUser;
    // ...
}
```

The `ForumUser` trait provides:

- `forums()` relationship - Get all forums the user is assigned to
- `favoriteForumPosts()` relationship - Get all favorite forum posts
- `getMentionableUsers()` method - Customize which users are mentionable (see "Custom Mentionables" below)
- `hasCustomForumSearch()`, `getForumSearchResults()`, `getForumOptionLabel()` methods - Custom search functionality (see "Custom User Model, Attribute, and Search Functionality" below)
- `isForumAdmin()` method - Override to grant admin access to hidden forums (defaults to `false`)
- `canCreateForum()` method - Controls forum creation permissions (see "Forum Creation Permissions" below)

6. Add to your custom theme (usually`theme.css`) file:

To include the TailwindCSS styles used on frontend pages, add to your theme file:

```
@source '../../../../vendor/tapp/filament-forum';
```

That's it! The plugins will auto-register with Filament and be ready to use.

Optionally, you can publish the translation files with:

```
php artisan vendor:publish --tag="filament-forum-translations"
```

Multi-Tenancy Support
---------------------

[](#multi-tenancy-support)

Filament Forum includes built-in support for multi-tenancy, allowing you to scope forums and forum posts to specific tenants (e.g., teams, organizations, workspaces).

### ⚠️ Important: Enable Tenancy Before Migrations

[](#️-important-enable-tenancy-before-migrations)

**You MUST configure and enable tenancy in the config file BEFORE running the migrations.** The migrations check the tenancy configuration to determine whether to add tenant columns to the database tables. If you enable tenancy after running migrations, you'll need to manually add the tenant columns to your database.

### Setup

[](#setup)

#### 1. Configure Tenancy (Before Migrations!)

[](#1-configure-tenancy-before-migrations)

Edit your `config/filament-forum.php` file **before** running the migrations:

```
'tenancy' => [
    // Enable tenancy support
    'enabled' => true,

    // The Tenant model class (e.g., App\Models\Team::class, App\Models\Organization::class)
    'model' => \App\Models\Team::class,

    // The tenant relationship name (optional)
    // Defaults to snake_case of tenant model class name
    // For example: Team::class -> 'team', Organization::class -> 'organization'
    'relationship_name' => 'team',

    // The tenant column name (optional)
    // Defaults to snake_case of tenant model class name + '_id'
    // For example: Team::class -> 'team_id', Organization::class -> 'organization_id'
    'column' => 'team_id',
],
```

#### 2. Run Migrations

[](#2-run-migrations)

Now you can safely run the migrations, which will include the tenant columns:

```
php artisan vendor:publish --tag="filament-forum-migrations"
php artisan migrate
```

The following tables will include your tenant column (e.g., `team_id`):

- `forums`
- `forum_posts`
- `forum_comments`
- `forum_comment_reactions`
- `forum_post_views`

#### 3. Configure Your Filament Panel

[](#3-configure-your-filament-panel)

Make sure tenancy is enabled on your Filament panel (e.g., in `AdminPanelProvider.php`):

```
use Filament\Panel;
use App\Models\Team;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... other configuration
        ->tenant(Team::class)
        ->plugins([
            ForumAdminPlugin::make(),
            // ... other plugins
        ]);
}
```

#### 4. Implement Required Contracts on Your User Model

[](#4-implement-required-contracts-on-your-user-model)

Your User model needs to implement Filament's tenancy contracts (using `teams` tenant in this example):

```
use Filament\Models\Contracts\FilamentUser;
use Filament\Models\Contracts\HasTenants;
use Filament\Panel;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Support\Collection;

class User extends Authenticatable implements FilamentUser, HasTenants
{
    // Define the relationship to your tenant model (eg. teams)
    public function teams(): BelongsToMany
    {
        return $this->belongsToMany(Team::class);
    }

    // Required by FilamentUser
    public function canAccessPanel(Panel $panel): bool
    {
        return true; // Customize as needed
    }

    // Required by HasTenants
    public function getTenants(Panel $panel): Collection
    {
        return $this->teams;
    }

    // Required by HasTenants
    public function canAccessTenant(Model $tenant): bool
    {
        return $this->teams()->whereKey($tenant)->exists();
    }
}
```

#### 5. Implement Required Contracts on Your Tenant Model

[](#5-implement-required-contracts-on-your-tenant-model)

Your Tenant model (e.g., `Team`) should implement Filament's `HasName` contract:

```
use Filament\Models\Contracts\HasName;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;

class Team extends Model implements HasName
{
    // Define the inverse relationship
    public function users(): BelongsToMany
    {
        return $this->belongsToMany(User::class);
    }

    // Required by HasName
    public function getFilamentName(): string
    {
        return $this->name;
    }
}
```

### How It Works

[](#how-it-works)

Once tenancy is enabled:

1. **Automatic Scoping**: All forum and forum post queries are automatically scoped to the current tenant
2. **Automatic Association**: When creating forums or posts, they're automatically associated with the current tenant
3. **Access Control**: Users can only access forums and posts belonging to their current tenant

### URL Structure with Tenancy

[](#url-structure-with-tenancy)

With tenancy enabled, your Filament panel URLs will include the tenant identifier:

```
/admin/{tenant-slug}/forums
/admin/{tenant-slug}/forum-posts

```

For example:

```
/admin/acme-company/forums
/admin/acme-company/forum-posts

```

### Disabling Tenancy

[](#disabling-tenancy)

To disable tenancy, simply set `'enabled' => false` in your `config/filament-forum.php`:

```
'tenancy' => [
    'enabled' => false,
    'model' => null,
],
```

**Note**: If you've already run migrations with tenancy enabled, the tenant columns will remain in your database. You'll need to handle existing tenant-scoped data appropriately or create a migration to remove the columns if needed.

### Important Notes

[](#important-notes)

- **Migrations First**: Always configure tenancy before running migrations
- **Data Migration**: If you enable tenancy on an existing installation, you'll need to manually add tenant columns and populate them with appropriate values
- **Testing**: When testing with tenancy enabled, ensure your factories and seeders properly associate records with tenants

For more detailed information about implementing multi-tenancy in Filament, see the [official Filament tenancy documentation](https://filamentphp.com/docs/4.x/users/tenancy).

Custom User Model, Attribute, and Search Functionality
------------------------------------------------------

[](#custom-user-model-attribute-and-search-functionality)

By default, the `name` column of `User` model is used for the `user` relationship. You can customize it using the `title-attribute` on `filament-forum.php` config file.

The Filament Forum plugin also supports custom search functionality for user selects in forms and filters. This allows you to customize which users' columns are used to search and display in dropdowns (eg. if your `User` model doesn't have a `name` column).

### Configure Your User Model Class

[](#configure-your-user-model-class)

Make sure your `config/filament-forum.php` file points to the correct `User` model:

```
'user' => [
    'title-attribute' => 'name',
    'model' => 'App\\Models\\User',  // Your User model class
],
```

### Customize the Search Methods

[](#customize-the-search-methods)

Override the trait methods in your User model to customize search behavior:

```