版本：Current

Replicate action

Introduction

Filament includes an action that is able to replicate Eloquent records. You may use it like so:

use Filament\Actions\ReplicateAction;

ReplicateAction::make()

Excluding attributes

The excludeAttributes() method is used to instruct the action which columns should be excluded from replication:

use Filament\Actions\ReplicateAction;

ReplicateAction::make()
    ->excludeAttributes(['slug'])

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 use the mutateRecordDataUsing() method to modify the $data array, and return the modified version before it is filled into the form:

use Filament\Actions\ReplicateAction;

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

        return $data;
    })

Redirecting after replication

You may set up a custom redirect when the form is submitted using the successRedirectUrl() method:

use Filament\Actions\ReplicateAction;

ReplicateAction::make()
    ->successRedirectUrl(route('posts.list'))

As well as $record, the successRedirectUrl() function can inject various utilities as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Action	`Filament\Actions\Action`	`$action`	The current action instance.
Arguments	`array<string, mixed>`	`$arguments`	The array of arguments passed to the action when it was triggered.
Data	`array<string, mixed>`	`$data`	The array of data submitted from form fields in the action's modal. It will be empty before the modal form is submitted.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent model FQN	`?string<Illuminate\Database\Eloquent\Model>`	`$model`	The Eloquent model FQN for the current action, if one is attached.
Mounted actions	`array<Filament\Actions\Action>`	`$mountedActions`	The array of actions that are currently mounted in the Livewire component. This is useful for accessing data from parent actions.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current action, if one is attached.
Replica Eloquent record	`Illuminate\Database\Eloquent\Model`	`$replica`	The Eloquent model instance that was just created as a replica of the original record.
Schema	`Filament\Schemas\Schema`	`$schema`	[Actions in schemas only] The schema object that this action belongs to.
Schema component	`Filament\Schemas\Components\Component`	`$schemaComponent`	[Actions in schemas only] The schema component that this action belongs to.
Schema component state	`mixed`	`$schemaComponentState`	[Actions in schemas only] The current value of the schema component.
Schema get function	`Filament\Schemas\Components\Utilities\Get`	`$schemaGet`	[Actions in schemas only] A function for retrieving values from the schema data. Validation is not run on form fields.
Schema operation	`string`	`$schemaOperation`	[Actions in schemas only] The current operation being performed by the schema. Usually <code>create</code>, <code>edit</code>, or <code>view</code>.
Schema set function	`Filament\Schemas\Components\Utilities\Set`	`$schemaSet`	[Actions in schemas only] A function for setting values in the schema data.
Selected Eloquent records	`Illuminate\Support\Collection`	`$selectedRecords`	[Bulk actions only] The Eloquent records selected in the table.
Table	`Filament\Tables\Table`	`$table`	[Actions in tables only] The table object that this action belongs to.

Customizing the replicate notification

When the record is successfully replicated, a notification is dispatched to the user, which indicates the success of their action.

To customize the title of this notification, use the successNotificationTitle() method:

use Filament\Actions\ReplicateAction;

ReplicateAction::make()
    ->successNotificationTitle('Category replicated')

As well as allowing a static value, the successNotificationTitle() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Action	`Filament\Actions\Action`	`$action`	The current action instance.
Arguments	`array<string, mixed>`	`$arguments`	The array of arguments passed to the action when it was triggered.
Data	`array<string, mixed>`	`$data`	The array of data submitted from form fields in the action's modal. It will be empty before the modal form is submitted.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent model FQN	`?string<Illuminate\Database\Eloquent\Model>`	`$model`	The Eloquent model FQN for the current action, if one is attached.
Mounted actions	`array<Filament\Actions\Action>`	`$mountedActions`	The array of actions that are currently mounted in the Livewire component. This is useful for accessing data from parent actions.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current action, if one is attached.
Replica Eloquent record	`Illuminate\Database\Eloquent\Model`	`$replica`	The Eloquent model instance that was just created as a replica of the original record.
Schema	`Filament\Schemas\Schema`	`$schema`	[Actions in schemas only] The schema object that this action belongs to.
Schema component	`Filament\Schemas\Components\Component`	`$schemaComponent`	[Actions in schemas only] The schema component that this action belongs to.
Schema component state	`mixed`	`$schemaComponentState`	[Actions in schemas only] The current value of the schema component.
Schema get function	`Filament\Schemas\Components\Utilities\Get`	`$schemaGet`	[Actions in schemas only] A function for retrieving values from the schema data. Validation is not run on form fields.
Schema operation	`string`	`$schemaOperation`	[Actions in schemas only] The current operation being performed by the schema. Usually <code>create</code>, <code>edit</code>, or <code>view</code>.
Schema set function	`Filament\Schemas\Components\Utilities\Set`	`$schemaSet`	[Actions in schemas only] A function for setting values in the schema data.
Selected Eloquent records	`Illuminate\Support\Collection`	`$selectedRecords`	[Bulk actions only] The Eloquent records selected in the table.
Table	`Filament\Tables\Table`	`$table`	[Actions in tables only] The table object that this action belongs to.

You may customize the entire notification using the successNotification() method:

use Filament\Actions\ReplicateAction;
use Filament\Notifications\Notification;

ReplicateAction::make()
    ->successNotification(
       Notification::make()
            ->success()
            ->title('Category replicated')
            ->body('The category has been replicated successfully.'),
    )

As well as allowing a static value, the successNotification() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Action	`Filament\Actions\Action`	`$action`	The current action instance.
Arguments	`array<string, mixed>`	`$arguments`	The array of arguments passed to the action when it was triggered.
Data	`array<string, mixed>`	`$data`	The array of data submitted from form fields in the action's modal. It will be empty before the modal form is submitted.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent model FQN	`?string<Illuminate\Database\Eloquent\Model>`	`$model`	The Eloquent model FQN for the current action, if one is attached.
Mounted actions	`array<Filament\Actions\Action>`	`$mountedActions`	The array of actions that are currently mounted in the Livewire component. This is useful for accessing data from parent actions.
Notification	`Filament\Notifications\Notification`	`$notification`	The default notification object, which could be a useful starting point for customization.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current action, if one is attached.
Replica Eloquent record	`Illuminate\Database\Eloquent\Model`	`$replica`	The Eloquent model instance that was just created as a replica of the original record.
Schema	`Filament\Schemas\Schema`	`$schema`	[Actions in schemas only] The schema object that this action belongs to.
Schema component	`Filament\Schemas\Components\Component`	`$schemaComponent`	[Actions in schemas only] The schema component that this action belongs to.
Schema component state	`mixed`	`$schemaComponentState`	[Actions in schemas only] The current value of the schema component.
Schema get function	`Filament\Schemas\Components\Utilities\Get`	`$schemaGet`	[Actions in schemas only] A function for retrieving values from the schema data. Validation is not run on form fields.
Schema operation	`string`	`$schemaOperation`	[Actions in schemas only] The current operation being performed by the schema. Usually <code>create</code>, <code>edit</code>, or <code>view</code>.
Schema set function	`Filament\Schemas\Components\Utilities\Set`	`$schemaSet`	[Actions in schemas only] A function for setting values in the schema data.
Selected Eloquent records	`Illuminate\Support\Collection`	`$selectedRecords`	[Bulk actions only] The Eloquent records selected in the table.
Table	`Filament\Tables\Table`	`$table`	[Actions in tables only] The table object that this action belongs to.

To disable the notification altogether, use the successNotification(null) method:

use Filament\Actions\RestoreAction;

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

Lifecycle hooks

Hooks may be used to execute code at various points within the action's lifecycle, like before the replica is saved.

use Filament\Actions\ReplicateAction;
use Illuminate\Database\Eloquent\Model;

ReplicateAction::make()
    ->before(function () {
        // Runs before the record has been replicated.
    })
    ->beforeReplicaSaved(function (Model $replica): void {
        // Runs after the record has been replicated but before it is saved to the database.
    })
    ->after(function (Model $replica): void {
        // Runs after the replica has been saved to the database.
    })

These hook functions can inject various utilities as parameters.

Learn more about utility injection.

Utility	Type	Parameter	Description
Action	`Filament\Actions\Action`	`$action`	The current action instance.
Arguments	`array<string, mixed>`	`$arguments`	The array of arguments passed to the action when it was triggered.
Data	`array<string, mixed>`	`$data`	The array of data submitted from form fields in the action's modal. It will be empty before the modal form is submitted.
Livewire	`Livewire\Component`	`$livewire`	The Livewire component instance.
Eloquent model FQN	`?string<Illuminate\Database\Eloquent\Model>`	`$model`	The Eloquent model FQN for the current action, if one is attached.
Mounted actions	`array<Filament\Actions\Action>`	`$mountedActions`	The array of actions that are currently mounted in the Livewire component. This is useful for accessing data from parent actions.
Eloquent record	`?Illuminate\Database\Eloquent\Model`	`$record`	The Eloquent record for the current action, if one is attached.
Replica Eloquent record	`Illuminate\Database\Eloquent\Model`	`$replica`	The Eloquent model instance that was just created as a replica of the original record.
Schema	`Filament\Schemas\Schema`	`$schema`	[Actions in schemas only] The schema object that this action belongs to.
Schema component	`Filament\Schemas\Components\Component`	`$schemaComponent`	[Actions in schemas only] The schema component that this action belongs to.
Schema component state	`mixed`	`$schemaComponentState`	[Actions in schemas only] The current value of the schema component.
Schema get function	`Filament\Schemas\Components\Utilities\Get`	`$schemaGet`	[Actions in schemas only] A function for retrieving values from the schema data. Validation is not run on form fields.
Schema operation	`string`	`$schemaOperation`	[Actions in schemas only] The current operation being performed by the schema. Usually <code>create</code>, <code>edit</code>, or <code>view</code>.
Schema set function	`Filament\Schemas\Components\Utilities\Set`	`$schemaSet`	[Actions in schemas only] A function for setting values in the schema data.
Selected Eloquent records	`Illuminate\Support\Collection`	`$selectedRecords`	[Bulk actions only] The Eloquent records selected in the table.
Table	`Filament\Tables\Table`	`$table`	[Actions in tables only] The table object that this action belongs to.

Halting the replication process

At any time, you may call $action->halt() from inside a lifecycle hook, which will halt the entire replication process:

use App\Models\Post;
use Filament\Actions\Action;
use Filament\Actions\ReplicateAction;
use Filament\Notifications\Notification;

ReplicateAction::make()
    ->before(function (ReplicateAction $action, Post $record) {
        if (! $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();

Introduction​

Excluding attributes​

Customizing data before filling the form​

Redirecting after replication​

Customizing the replicate notification​

Lifecycle hooks​

Halting the replication process​

Introduction

Excluding attributes

Customizing data before filling the form

Redirecting after replication

Customizing the replicate notification

Lifecycle hooks

Halting the replication process