Resources

Introduction

Resources are the primary way to manage Eloquent models in Filament. They provide a complete CRUD interface with minimal configuration, including list views, forms, and additional functionality like global search and authorization.

Creating a resource

You can generate a resource using the Artisan command:

php artisan make:filament-resource User

This creates a resource class and associated page classes:

app/Filament/Resources/
├── UserResource.php
└── UserResource/
    └── Pages/
        ├── CreateUser.php
        ├── EditUser.php
        └── ListUsers.php

Defining the model

Every resource must specify which Eloquent model it manages:

use App\Models\User;
use Filament\Resources\Resource;

class UserResource extends Resource
{
    protected static ?string $model = User::class;

    // ...
}

If you follow Laravel’s naming conventions, Filament will automatically detect the model. For example, UserResource will use App\Models\User.

Configuring the form

The form() method defines the form schema for creating and editing records:

use Filament\Forms\Components\TextInput;
use Filament\Forms\Components\Select;
use Filament\Schemas\Schema;

public static function form(Schema $schema): Schema
{
    return $schema
        ->schema([
            TextInput::make('name')
                ->required()
                ->maxLength(255),
            TextInput::make('email')
                ->email()
                ->required()
                ->maxLength(255),
            Select::make('role')
                ->options([
                    'admin' => 'Admin',
                    'editor' => 'Editor',
                    'viewer' => 'Viewer',
                ])
                ->required(),
        ]);
}

Configuring the table

The table() method defines the columns and actions for the list view:

use Filament\Tables\Columns\TextColumn;
use Filament\Tables\Filters\SelectFilter;
use Filament\Tables\Actions\EditAction;
use Filament\Tables\Actions\DeleteBulkAction;
use Filament\Tables\Table;

public static function table(Table $table): Table
{
    return $table
        ->columns([
            TextColumn::make('name')
                ->searchable()
                ->sortable(),
            TextColumn::make('email')
                ->searchable()
                ->sortable(),
            TextColumn::make('role')
                ->badge()
                ->color(fn (string $state): string => match ($state) {
                    'admin' => 'danger',
                    'editor' => 'warning',
                    'viewer' => 'success',
                }),
            TextColumn::make('created_at')
                ->dateTime()
                ->sortable(),
        ])
        ->filters([
            SelectFilter::make('role')
                ->options([
                    'admin' => 'Admin',
                    'editor' => 'Editor',
                    'viewer' => 'Viewer',
                ]),
        ])
        ->actions([
            EditAction::make(),
        ])
        ->bulkActions([
            DeleteBulkAction::make(),
        ]);
}

Resource pages

Resources use separate page classes for different operations. The default setup includes:

List page

Displays a table of all records:

use Filament\Resources\Pages\ListRecords;

class ListUsers extends ListRecords
{
    protected static string $resource = UserResource::class;
}

Create page

Provides a form for creating new records:

use Filament\Resources\Pages\CreateRecord;

class CreateUser extends CreateRecord
{
    protected static string $resource = UserResource::class;
}

Edit page

Provides a form for editing existing records:

use Filament\Resources\Pages\EditRecord;

class EditUser extends EditRecord
{
    protected static string $resource = UserResource::class;
}

Registering pages

Pages are registered in the resource’s getPages() method:

public static function getPages(): array
{
    return [
        'index' => Pages\ListUsers::route('/'),
        'create' => Pages\CreateUser::route('/create'),
        'edit' => Pages\EditUser::route('/{record}/edit'),
    ];
}

Customizing the Eloquent query

You can modify the Eloquent query used by the resource:

use Illuminate\Database\Eloquent\Builder;

public static function getEloquentQuery(): Builder
{
    return parent::getEloquentQuery()
        ->withoutGlobalScopes()
        ->where('is_active', true);
}

By default, getEloquentQuery() removes the panel’s tenancy scope. If your resource is scoped to a tenant, this behavior is automatically preserved.

Relation managers

Relation managers allow you to manage related records directly from the parent resource:

use App\Filament\Resources\UserResource\RelationManagers\PostsRelationManager;

public static function getRelations(): array
{
    return [
        PostsRelationManager::class,
    ];
}

Generate a relation manager using:

php artisan make:filament-relation-manager UserResource posts title

Global search

Enable global search for a resource by defining which attributes to search:

protected static ?string $recordTitleAttribute = 'name';

For more advanced search, override the method:

public static function getGlobalSearchResultTitle(Model $record): string
{
    return $record->name;
}

public static function getGlobalSearchResultDetails(Model $record): array
{
    return [
        'Email' => $record->email,
        'Role' => $record->role,
    ];
}

public static function getGlobalSearchEloquentQuery(): Builder
{
    return parent::getGlobalSearchEloquentQuery()->with(['department']);
}

Authorization

Filament integrates with Laravel’s authorization system. Define policies to control access:

// app/Policies/UserPolicy.php
public function viewAny(User $user): bool
{
    return $user->can('view_users');
}

public function create(User $user): bool
{
    return $user->can('create_users');
}

public function update(User $user, User $model): bool
{
    return $user->can('edit_users');
}

public function delete(User $user, User $model): bool
{
    return $user->can('delete_users');
}

protected $policies = [
    User::class => UserPolicy::class,
];

Customize how the resource appears in navigation:

protected static ?string $navigationIcon = 'heroicon-o-users';

protected static ?string $navigationLabel = 'Team Members';

protected static ?int $navigationSort = 1;

protected static ?string $navigationGroup = 'User Management';

Labels

Customize the labels used throughout the resource:

protected static ?string $modelLabel = 'team member';

protected static ?string $pluralModelLabel = 'team members';

public static function getNavigationLabel(): string
{
    return 'Team';
}

Widgets

Add widgets to resource pages:

public static function getWidgets(): array
{
    return [
        Widgets\UserStatsWidget::class,
    ];
}

Display them on a page:

use Filament\Resources\Pages\ListRecords;

class ListUsers extends ListRecords
{
    protected static string $resource = UserResource::class;

    protected function getHeaderWidgets(): array
    {
        return [
            UserResource\Widgets\UserStatsWidget::class,
        ];
    }
}

Resource clusters

Group related resources together using clusters:

use App\Filament\Clusters\Settings;

class UserResource extends Resource
{
    protected static ?string $cluster = Settings::class;

    // ...
}

Generate a cluster:

php artisan make:filament-cluster Settings

Simple resources

For simple CRUD operations on a single page, use a simple resource:

php artisan make:filament-resource Product --simple

This creates a single “Manage” page instead of separate list, create, and edit pages.

Getting Started

Panel Builder

Core Concepts

Building Blocks

Advanced

Introduction

Creating a resource

Defining the model

Configuring the form

Configuring the table

Resource pages

List page

Create page

Edit page

Registering pages

Customizing the Eloquent query

Relation managers

Global search

Authorization

Navigation

Labels

Widgets

Resource clusters

Simple resources

​Introduction

​Creating a resource

​Defining the model

​Configuring the form

​Configuring the table

​Resource pages

​List page

​Create page

​Edit page

​Registering pages

​Customizing the Eloquent query

​Relation managers

​Global search

​Authorization

​Navigation

​Labels

​Widgets

​Resource clusters

​Simple resources

Introduction

Creating a resource

Defining the model

Configuring the form

Configuring the table

Resource pages

List page

Create page

Edit page

Registering pages

Customizing the Eloquent query

Relation managers

Global search

Authorization

Navigation

Labels

Widgets

Resource clusters

Simple resources