Editing Records

Resources

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

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, 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;
}

Customizing the saving process

You can tweak how the record is updated using the handleRecordUpdate() method:

use Illuminate\Database\Eloquent\Model;
 
protected function handleRecordUpdate(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.

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

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 text content of this notification:

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

And to disable the notification altogether:

protected function getSavedNotificationMessage(): ?string
{
return 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 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.
}
 
protected function beforeDelete(): void
{
// Runs before the record is deleted.
}
 
protected function afterDelete(): void
{
// Runs after the record is deleted.
}
}

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

Still need help? Join our Discord community or open a GitHub discussion

Enjoying Filament?

We are open source at heart. To allow us to build new features, fix bugs, and run the community, we require your financial support.

Sponsor Filament on GitHub