Editing Records

The Edit Page

The Edit page displays a form for modifying existing records. It’s defined in EditCustomer.php:

packages/panels/src/Resources/Pages/EditRecord.php

class EditRecord extends Page
{
    use CanUseDatabaseTransactions;
    use HasUnsavedDataChangesAlert;
    
    public ?array $data = [];
    
    public function mount(int | string $record): void
    {
        $this->record = $this->resolveRecord($record);
        $this->fillForm();
    }
    
    public function save(): void
    {
        // Saving logic
    }
}

Form Prefilling

When the page loads, the form is automatically filled with the record’s data. The mount() method handles this:

packages/panels/src/Resources/Pages/EditRecord.php

protected function fillForm(): void
{
    $this->callHook('beforeFill');
    
    $data = $this->mutateFormDataBeforeFill(
        $this->getRecord()->attributesToArray()
    );
    
    $this->form->fill($data);
    
    $this->callHook('afterFill');
}

Customizing Data Before Fill

Modify data before it’s loaded into the form:

protected function mutateFormDataBeforeFill(array $data): array
{
    $data['formatted_price'] = number_format($data['price'], 2);
    
    return $data;
}

Formatting Dates
Hiding Sensitive Data
Merging Related Data

protected function mutateFormDataBeforeFill(array $data): array
{
    $data['published_at'] = Carbon::parse($data['published_at'])
        ->format('Y-m-d');
    
    return $data;
}

protected function mutateFormDataBeforeFill(array $data): array
{
    unset($data['password']);
    unset($data['api_token']);
    
    return $data;
}

protected function mutateFormDataBeforeFill(array $data): array
{
    $data['full_address'] = collect([
        $data['street'],
        $data['city'],
        $data['postal_code'],
    ])->filter()->implode(', ');
    
    return $data;
}

Lifecycle Hooks

Execute code at specific points during editing:

packages/panels/src/Resources/Pages/EditRecord.php

protected function beforeFill(): void
{
    // Runs before the form fields are populated from the database
}

protected function afterFill(): void
{
    // Runs after the form fields are populated from the database
}

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

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

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

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

Mutating Data Before Save

Modify form data before it’s saved:

packages/panels/src/Resources/Pages/EditRecord.php

protected function mutateFormDataBeforeSave(array $data): array
{
    $data['last_edited_by_id'] = auth()->id();
    $data['updated_at'] = now();
    
    return $data;
}

This runs after validation but before beforeSave().

Customizing the Saving Process

Override how records are updated:

packages/panels/src/Resources/Pages/EditRecord.php

protected function handleRecordUpdate(Model $record, array $data): Model
{
    $record->update($data);
    
    return $record;
}

For custom update logic:

use Illuminate\Database\Eloquent\Model;

protected function handleRecordUpdate(Model $record, array $data): Model
{
    // Update main record
    $record->update([
        'name' => $data['name'],
        'email' => $data['email'],
    ]);
    
    // Update related records
    if (isset($data['preferences'])) {
        $record->preferences()->update($data['preferences']);
    }
    
    return $record;
}

Redirects After Save

By default, users stay on the Edit page after saving.

Redirect to List Page

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

Redirect to View Page

protected function getRedirectUrl(): ?string
{
    return $this->getResource()::getUrl('view', ['record' => $this->getRecord()]);
}

Stay on Page

protected function getRedirectUrl(): ?string
{
    return null;
}

Global Configuration

use Filament\Panel;

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

Success Notifications

Customize the success notification:

packages/panels/src/Resources/Pages/EditRecord.php

protected function getSavedNotificationTitle(): ?string
{
    return 'Customer updated successfully';
}

Full customization:

use Filament\Notifications\Notification;

protected function getSavedNotification(): ?Notification
{
    return Notification::make()
        ->success()
        ->title('Customer updated')
        ->body('The customer has been saved successfully.');
}

Disable notifications:

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

Saving Form Sections Independently

Allow users to save individual form sections:

use Filament\Actions\Action;
use Filament\Notifications\Notification;
use Filament\Resources\Pages\EditRecord;
use Filament\Schemas\Components\Section;

Section::make('Rate limiting')
    ->schema([
        // ...
    ])
    ->footerActions([
        fn (string $operation): Action => Action::make('save')
            ->action(function (Section $component, EditRecord $livewire) {
                $livewire->saveFormComponentOnly($component);
                
                Notification::make()
                    ->title('Rate limiting saved')
                    ->success()
                    ->send();
            })
            ->visible($operation === 'edit'),
    ])

Halting the Save Process

Stop saving at any point:

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

protected function beforeSave(): void
{
    if (! $this->getRecord()->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();
    }
}

Refreshing Form Data

Refresh specific fields from the database:

packages/panels/src/Resources/Pages/EditRecord.php

public function refreshFormData(array $statePaths): void
{
    $this->form->fillPartially(
        $this->mutateFormDataBeforeFill($this->getRecord()->attributesToArray()),
        $statePaths
    );
}

Useful after background jobs update records:

$this->refreshFormData(['status', 'processed_at']);

Header Actions

Add actions to the page header:

use Filament\Actions;

protected function getHeaderActions(): array
{
    return [
        Actions\ViewAction::make(),
        Actions\DeleteAction::make(),
        Actions\ForceDeleteAction::make(),
        Actions\RestoreAction::make(),
    ];
}

Custom Form Actions

Add buttons below the form:

use Filament\Actions\Action;

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

public function saveAndEmail(): void
{
    $this->save();
    
    Mail::to($this->getRecord()->email)
        ->send(new UpdateEmail($this->getRecord()));
}

Moving Save to Header

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

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

Multiple Edit Pages

Create additional Edit pages for complex resources:

Generate the page

php artisan make:filament-page EditCustomerContact --resource=CustomerResource --type=EditRecord

public static function getPages(): array
{
    return [
        'index' => Pages\ListCustomers::route('/'),
        'create' => Pages\CreateCustomer::route('/create'),
        'edit' => Pages\EditCustomer::route('/{record}/edit'),
        'edit-contact' => Pages\EditCustomerContact::route('/{record}/edit/contact'),
    ];
}

Define its form

use Filament\Schemas\Schema;

public function form(Schema $schema): Schema
{
    return $schema
        ->components([
            // Different fields than the main Edit page
        ]);
}

Authorization

Users can access the Edit page if the update() method of the model policy returns true:

public function update(User $user, Customer $customer): bool
{
    return $user->can('edit customers');
}

They can also delete the record if delete() returns true:

public function delete(User $user, Customer $customer): bool
{
    return $user->can('delete customers');
}

Database Transactions

Edit pages automatically wrap saves in database transactions. This is controlled by the CanUseDatabaseTransactions trait. To disable transactions:

protected function beginDatabaseTransaction(): void
{
    // Do nothing
}

protected function commitDatabaseTransaction(): void
{
    // Do nothing
}

protected function rollBackDatabaseTransaction(): void
{
    // Do nothing
}

Unsaved Changes Alert

The HasUnsavedDataChangesAlert trait warns users when they try to leave with unsaved changes. This is enabled by default.

Getting Started

Panel Builder

Core Concepts

Building Blocks

Advanced

The Edit Page

Form Prefilling

Customizing Data Before Fill

Lifecycle Hooks

Mutating Data Before Save

Customizing the Saving Process

Redirects After Save

Redirect to List Page

Redirect to View Page

Stay on Page

Global Configuration

Success Notifications

Saving Form Sections Independently

Halting the Save Process

Refreshing Form Data

Header Actions

Custom Form Actions

Moving Save to Header

Multiple Edit Pages

Authorization

Database Transactions

Unsaved Changes Alert

​The Edit Page

​Form Prefilling

​Customizing Data Before Fill

​Lifecycle Hooks

​Mutating Data Before Save

​Customizing the Saving Process

​Redirects After Save

​Redirect to List Page

​Redirect to View Page

​Stay on Page

​Global Configuration

​Success Notifications

​Saving Form Sections Independently

​Halting the Save Process

​Refreshing Form Data

​Header Actions

​Custom Form Actions

​Moving Save to Header

​Multiple Edit Pages

​Authorization

​Database Transactions

​Unsaved Changes Alert

The Edit Page

Form Prefilling

Customizing Data Before Fill

Lifecycle Hooks

Mutating Data Before Save

Customizing the Saving Process

Redirects After Save

Redirect to List Page

Redirect to View Page

Stay on Page

Global Configuration

Success Notifications

Saving Form Sections Independently

Halting the Save Process

Refreshing Form Data

Header Actions

Custom Form Actions

Moving Save to Header

Multiple Edit Pages

Authorization

Database Transactions

Unsaved Changes Alert