Editing records - Filament

You are currently viewing the documentation for Filament 2.x, which is a previous version of Filament.Looking for the current stable version? Visit the 5.x documentation.

Customizing data before filling the form

You may wish to modify the data from a record before it is filled into the form. To do this, you may define a mutateFormDataBeforeFill() method on the Edit page class to modify the $data array, and return the modified version before it is filled into the form:

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

    return $data;
}

Alternatively, if you’re editing records in a modal action:

use Filament\Tables\Actions\EditAction;

EditAction::make()
    ->mutateRecordDataUsing(function (array $data): array {
        $data['user_id'] = auth()->id();

        return $data;
    })

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 mutateFormDataBeforeSave() method on the Edit page class, which accepts the $data as an array, and returns it modified:

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

    return $data;
}

Alternatively, if you’re editing records in a modal action:

use Filament\Tables\Actions\EditAction;

EditAction::make()
    ->mutateFormDataUsing(function (array $data): array {
        $data['last_edited_by_id'] = auth()->id();

        return $data;
    })

Customizing the saving process

You can tweak how the record is updated using the handleRecordUpdate() method on the Edit page class:

use Illuminate\Database\Eloquent\Model;

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

    return $record;
}

Alternatively, if you’re editing records in a modal action:

use Filament\Tables\Actions\EditAction;
use Illuminate\Database\Eloquent\Model;

EditAction::make()
    ->using(function (Model $record, array $data): Model {
        $record->update($data);

        return $record;
    })

Customizing form redirects

By default, saving the form will not redirect the user to another page. You may set up a custom redirect when the form is saved by overriding the getRedirectUrl() method on the Edit page class. For example, the form can redirect back to the List page of the resource:

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

Or the View page:

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

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');
}

Customizing the save notification

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

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

Alternatively, if you’re editing records in a modal action:

use Filament\Tables\Actions\EditAction;

EditAction::make()
    ->successNotificationTitle('User updated')

You may customize the entire notification by overriding the getSavedNotification() method on the edit page class:

use Filament\Notifications\Notification;

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

Alternatively, if you’re editing records in a modal action:

use Filament\Notifications\Notification;
use Filament\Tables\Actions\EditAction;

EditAction::make()
    ->successNotification(
       Notification::make()
            ->success()
            ->title('User updated')
            ->body('The user has been saved successfully.'),
    )

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

use Filament\Notifications\Notification;

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

Alternatively, if you’re editing records in a modal action:

use Filament\Tables\Actions\EditAction;

EditAction::make()
    ->successNotification(null)

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 Edit page class with the name of the hook:

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

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

use Filament\Resources\Pages\EditRecord;

class EditUser extends EditRecord
{
    // ...

    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.
    }
}

Alternatively, if you’re editing records in a modal action:

use Filament\Tables\Actions\EditAction;

EditAction::make()
    ->beforeFormFilled(function () {
        // Runs before the form fields are populated from the database.
    })
    ->afterFormFilled(function () {
        // Runs after the form fields are populated from the database.
    })
    ->beforeFormValidated(function () {
        // Runs before the form fields are validated when the form is saved.
    })
    ->afterFormValidated(function () {
        // Runs after the form fields are validated when the form is saved.
    })
    ->before(function () {
        // Runs before the form fields are saved to the database.
    })
    ->after(function () {
        // Runs after the form fields are saved to the database.
    })

Halting the saving process

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

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

protected function beforeSave(): void
{
    if (! $this->record->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 editing records in a modal action:

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

EditAction::make()
    ->before(function (EditAction $action) {
        if (! $this->record->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();
        
            $action->halt();
        }
    })

If you’d like the action modal to close too, you can completely cancel() the action instead of halting it:

$action->cancel();

Authorization

For authorization, Filament will observe any model policies that are registered in your app. Users may access the Edit page if the update() method of the model policy returns true. They also have the ability to delete the record if the delete() method of the policy returns true.

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 next to “Delete” on the Edit page that runs the impersonate() Livewire method:

use Filament\Pages\Actions;
use Filament\Resources\Pages\EditRecord;

class EditUser extends EditRecord
{
    // ...

    protected function getActions(): array
    {
        return [
            Actions\Action::make('impersonate')->action('impersonate'),
            Actions\DeleteAction::make(),
        ];
    }

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

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

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

class EditUser extends EditRecord
{
    // ...

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

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

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

Custom views

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

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

​Customizing data before filling the form

​Customizing data before saving

​Customizing the saving process

​Customizing form redirects

​Customizing the save notification

​Lifecycle hooks

​Halting the saving process

​Authorization

​Custom actions

​Custom views

Customizing data before filling the form

Customizing data before saving

Customizing the saving process

Customizing form redirects

Customizing the save notification

Lifecycle hooks

Halting the saving process

Authorization

Custom actions

Custom views