Creating records - Filament

Customizing data before saving

Sometimes, you may wish to modify form data before it is finally saved to the database. To do this, you may define a mutateFormDataBeforeCreate() method on the Create page class, which accepts the $data as an array, and returns the modified version:

protected function mutateFormDataBeforeCreate(array $data): array
{
    $data['user_id'] = auth()->id();

    return $data;
}

Alternatively, if you’re creating records in a modal action, check out the Actions documentation.

Customizing the creation process

You can tweak how the record is created using the handleRecordCreation() method on the Create page class:

use Illuminate\Database\Eloquent\Model;

protected function handleRecordCreation(array $data): Model
{
    return static::getModel()::create($data);
}

Alternatively, if you’re creating records in a modal action, check out the Actions documentation.

Customizing redirects

By default, after saving the form, the user will be redirected to the Edit page of the resource, or the View page if it is present. You may set up a custom redirect when the form is saved by overriding the getRedirectUrl() method on the Create page class. For example, the form can redirect back to the List page:

protected function getRedirectUrl(): string
{
    return $this->getResource()::getUrl('index');
}

If you wish to be redirected to the previous page, else the index page:

protected function getRedirectUrl(): string
{
    return $this->previousUrl ?? $this->getResource()::getUrl('index');
}

You can also use the configuration to customize the default redirect page for all resources at once:

use Filament\Panel;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->resourceCreatePageRedirect('index') // or
        ->resourceCreatePageRedirect('view') // or
        ->resourceCreatePageRedirect('edit');
}

Customizing the save notification

When the record is successfully created, a notification is dispatched to the user, which indicates the success of their action. To customize the title of this notification, define a getCreatedNotificationTitle() method on the create page class:

protected function getCreatedNotificationTitle(): ?string
{
    return 'User registered';
}

Alternatively, if you’re creating records in a modal action, check out the Actions documentation. You may customize the entire notification by overriding the getCreatedNotification() method on the create page class:

use Filament\Notifications\Notification;

protected function getCreatedNotification(): ?Notification
{
    return Notification::make()
        ->success()
        ->title('User registered')
        ->body('The user has been created successfully.');
}

To disable the notification altogether, return null from the getCreatedNotification() method on the create page class:

use Filament\Notifications\Notification;

protected function getCreatedNotification(): ?Notification
{
    return null;
}

Creating another record

Disabling create another

To disable the “create and create another” feature, define the $canCreateAnother property as false on the Create page class:

protected static bool $canCreateAnother = false;

Alternatively, if you’d like to specify a dynamic condition when the feature is disabled, you may override the canCreateAnother() method on the Create page class:

public function canCreateAnother(): bool
{
    return false;
}

Preserving data when creating another

By default, when the user uses the “create and create another” feature, all the form data is cleared so the user can start fresh. If you’d like to preserve some of the data in the form, you may override the preserveFormDataWhenCreatingAnother() method on the Create page class, and return the part of the $data array that you’d like to keep:

use Illuminate\Support\Arr;

protected function preserveFormDataWhenCreatingAnother(array $data): array
{
    return Arr::only($data, ['is_admin', 'organization']);
}

To preserve all the data, return the entire $data array:

protected function preserveFormDataWhenCreatingAnother(array $data): array
{
    return $data;
}

Lifecycle hooks

Hooks may be used to execute code at various points within a page’s lifecycle, like before a form is saved. To set up a hook, create a protected method on the Create page class with the name of the hook:

protected function beforeCreate(): void
{
    // ...
}

In this example, the code in the beforeCreate() method will be called before the data in the form is saved to the database. There are several available hooks for the Create page:

use Filament\Resources\Pages\CreateRecord;

class CreateUser extends CreateRecord
{
    // ...

    protected function beforeFill(): void
    {
        // Runs before the form fields are populated with their default values.
    }

    protected function afterFill(): void
    {
        // Runs after the form fields are populated with their default values.
    }

    protected function beforeValidate(): void
    {
        // Runs before the form fields are validated when the form is submitted.
    }

    protected function afterValidate(): void
    {
        // Runs after the form fields are validated when the form is submitted.
    }

    protected function beforeCreate(): void
    {
        // Runs before the form fields are saved to the database.
    }

    protected function afterCreate(): void
    {
        // Runs after the form fields are saved to the database.
    }
}

Alternatively, if you’re creating records in a modal action, check out the Actions documentation.

Halting the creation process

At any time, you may call $this->halt() from inside a lifecycle hook or mutation method, which will halt the entire creation process:

use Filament\Actions\Action;
use Filament\Notifications\Notification;

protected function beforeCreate(): void
{
    if (! auth()->user()->team->subscribed()) {
        Notification::make()
            ->warning()
            ->title('You don\'t have an active subscription!')
            ->body('Choose a plan to continue.')
            ->persistent()
            ->actions([
                Action::make('subscribe')
                    ->button()
                    ->url(route('subscribe'), shouldOpenInNewTab: true),
            ])
            ->send();
    
        $this->halt();
    }
}

Alternatively, if you’re creating records in a modal action, check out the Actions documentation.

Authorization

For authorization, Filament will observe any model policies that are registered in your app. Users may access the Create page if the create() method of the model policy returns true.

Using a wizard

You may easily transform the creation process into a multistep wizard. On the page class, add the corresponding HasWizard trait:

use App\Filament\Resources\Categories\CategoryResource;
use Filament\Resources\Pages\CreateRecord;

class CreateCategory extends CreateRecord
{
    use CreateRecord\Concerns\HasWizard;
    
    protected static string $resource = CategoryResource::class;

    protected function getSteps(): array
    {
        return [
            // ...
        ];
    }
}

Inside the getSteps() array, return your wizard steps:

use Filament\Forms\Components\MarkdownEditor;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Components\Toggle;
use Filament\Schemas\Components\Wizard\Step;

protected function getSteps(): array
{
    return [
        Step::make('Name')
            ->description('Give the category a clear and unique name')
            ->schema([
                TextInput::make('name')
                    ->required()
                    ->live()
                    ->afterStateUpdated(fn ($state, callable $set) => $set('slug', Str::slug($state))),
                TextInput::make('slug')
                    ->disabled()
                    ->required()
                    ->unique(Category::class, 'slug', fn ($record) => $record),
            ]),
        Step::make('Description')
            ->description('Add some extra details')
            ->schema([
                MarkdownEditor::make('description')
                    ->columnSpan('full'),
            ]),
        Step::make('Visibility')
            ->description('Control who can view it')
            ->schema([
                Toggle::make('is_visible')
                    ->label('Visible to customers.')
                    ->default(true),
            ]),
    ];
}

Alternatively, if you’re creating records in a modal action, check out the Actions documentation. Now, create a new record to see your wizard in action! Edit will still use the form defined within the resource class. If you’d like to allow free navigation, so all the steps are skippable, override the hasSkippableSteps() method:

public function hasSkippableSteps(): bool
{
    return true;
}

If you’d like to reduce the amount of repetition between the resource form and wizard steps, it’s a good idea to extract public static form functions for your fields, where you can easily retrieve an instance of a field from the form schema or the wizard:

use Filament\Forms;
use Filament\Schemas\Schema;

class CategoryForm
{
    public static function configure(Schema $schema): Schema
    {
        return $schema
            ->components([
                static::getNameFormField(),
                static::getSlugFormField(),
                // ...
            ]);
    }
    
    public static function getNameFormField(): Forms\Components\TextInput
    {
        return TextInput::make('name')
            ->required()
            ->live()
            ->afterStateUpdated(fn ($state, callable $set) => $set('slug', Str::slug($state)));
    }
    
    public static function getSlugFormField(): Forms\Components\TextInput
    {
        return TextInput::make('slug')
            ->disabled()
            ->required()
            ->unique(Category::class, 'slug', fn ($record) => $record);
    }
}

use App\Filament\Resources\Categories\Schemas\CategoryForm;
use Filament\Resources\Pages\CreateRecord;

class CreateCategory extends CreateRecord
{
    use CreateRecord\Concerns\HasWizard;
    
    protected static string $resource = CategoryResource::class;

    protected function getSteps(): array
    {
        return [
            Step::make('Name')
                ->description('Give the category a clear and unique name')
                ->schema([
                    CategoryForm::getNameFormField(),
                    CategoryForm::getSlugFormField(),
                ]),
            // ...
        ];
    }
}

Importing resource records

Filament includes an ImportAction that you can add to the getHeaderActions() of the List page. It allows users to upload a CSV of data to import into the resource:

use App\Filament\Imports\ProductImporter;
use Filament\Actions;

protected function getHeaderActions(): array
{
    return [
        Actions\ImportAction::make()
            ->importer(ProductImporter::class),
        Actions\CreateAction::make(),
    ];
}

The “importer” class needs to be created to tell Filament how to import each row of the CSV. You can learn everything about the ImportAction in the Actions documentation.

Custom actions

“Actions” are buttons that are displayed on pages, which allow the user to run a Livewire method on the page or visit a URL. On resource pages, actions are usually in 2 places: in the top right of the page, and below the form. For example, you may add a new button action in the header of the Create page:

use App\Filament\Imports\UserImporter;
use Filament\Actions;
use Filament\Resources\Pages\CreateRecord;

class CreateUser extends CreateRecord
{
    // ...

    protected function getHeaderActions(): array
    {
        return [
            Actions\ImportAction::make()
                ->importer(UserImporter::class),
        ];
    }
}

Or, a new button next to “Create” below the form:

use Filament\Actions\Action;
use Filament\Resources\Pages\CreateRecord;

class CreateUser extends CreateRecord
{
    // ...

    protected function getFormActions(): array
    {
        return [
            ...parent::getFormActions(),
            Action::make('close')->action('createAndClose'),
        ];
    }

    public function createAndClose(): void
    {
        // ...
    }
}

To view the entire actions API, please visit the pages section.

Adding a create action button to the header

The “Create” button can be moved to the header of the page by overriding the getHeaderActions() method and using getCreateFormAction(). You need to pass formId() to the action, to specify that the action should submit the form with the ID of form, which is the <form> ID used in the view of the page:

protected function getHeaderActions(): array
{
    return [
        $this->getCreateFormAction()
            ->formId('form'),
    ];
}

You may remove all actions from the form by overriding the getFormActions() method to return an empty array:

protected function getFormActions(): array
{
    return [];
}

Custom page content

Each page in Filament has its own schema, which defines the overall structure and content. You can override the schema for the page by defining a content() method on it. The content() method for the Create page contains the following components by default:

use Filament\Schemas\Schema;

public function content(Schema $schema): Schema
{
    return $schema
        ->components([
            $this->getFormContentComponent(), // This method returns a component to display the form that is defined in this resource
        ]);
}

Inside the components() array, you can insert any schema component. You can reorder the components by changing the order of the array or remove any of the components that are not needed.

Using a custom Blade view

For further customization opportunities, you can override the static $view property on the page class to a custom view in your app:

protected string $view = 'filament.resources.users.pages.create-user';

This assumes that you have created a view at resources/views/filament/resources/users/pages/create-user.blade.php:

<x-filament-panels::page>
    {{ $this->content }} {{-- This will render the content of the page defined in the `content()` method, which can be removed if you want to start from scratch --}}
</x-filament-panels::page>

​Customizing data before saving

​Customizing the creation process

​Customizing redirects

​Customizing the save notification

​Creating another record

​Disabling create another

​Preserving data when creating another

​Lifecycle hooks

​Halting the creation process

​Authorization

​Using a wizard

​Sharing fields between the form schema and wizards

​Importing resource records

​Custom actions

​Adding a create action button to the header

​Custom page content

​Using a custom Blade view

Customizing data before saving

Customizing the creation process

Customizing redirects

Customizing the save notification

Creating another record

Disabling create another

Preserving data when creating another

Lifecycle hooks

Halting the creation process

Authorization

Using a wizard

Sharing fields between the form schema and wizards

Importing resource records

Custom actions

Adding a create action button to the header

Custom page content

Using a custom Blade view