> ## Documentation Index
> Fetch the complete documentation index at: https://filamentphp.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Replicate action
export const EditOnGitHub = ({version, path}) => {
const url = `https://github.com/filamentphp/filament/edit/${version}/${path}`;
return ;
};
export const Footer = () => {
const sponsorsByTier = JSON.parse(`{
"agency_partner": [
{
"name": "Kirschbaum",
"url": "https://kirschbaumdevelopment.com/solutions/filament-development",
"filename": "kirschbaum.svg"
}
],
"gold": [
{
"name": "Agiledrop",
"url": "https://www.agiledrop.com/laravel?utm_source=filament",
"filename": "agiledrop.svg"
},
{
"name": "Baiz.ai",
"url": "https://baiz.ai",
"filename": "baiz-ai.svg"
},
{
"name": "CMS Max",
"url": "https://cmsmax.com?ref=filamentphp.com",
"filename": "cms-max.svg"
},
{
"name": "Mailtrap",
"url": "https://mailtrap.io/email-sending?utm_source=community&utm_medium=referral&utm_campaign=filament",
"filename": "mailtrap.svg"
},
{
"name": "SerpApi",
"url": "https://serpapi.com/?utm_source=filamentphp",
"filename": "serpapi.svg"
}
]
}`);
function shuffleArray(items) {
const result = [...items];
for (let index = result.length - 1; index > 0; index--) {
const randomIndex = Math.floor(Math.random() * (index + 1));
[result[index], result[randomIndex]] = [result[randomIndex], result[index]];
}
return result;
}
const sponsors = Object.entries(sponsorsByTier).flatMap(([, sponsors]) => shuffleArray(sponsors));
return ;
};
You are currently viewing the documentation for Filament 3.x, which is a previous version of Filament.
Looking for the current stable version? Visit the [5.x documentation](/5.x/actions).
## Overview
Filament includes a prebuilt action that is able to [replicate](https://laravel.com/docs/eloquent#replicating-models) Eloquent records. You may use it like so:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Actions\ReplicateAction;
ReplicateAction::make()
->record($this->post)
```
If you want to replicate table rows, you can use the `Filament\Tables\Actions\ReplicateAction` instead:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Tables\Actions\ReplicateAction;
use Filament\Tables\Table;
public function table(Table $table): Table
{
return $table
->actions([
ReplicateAction::make(),
// ...
]);
}
```
## Excluding attributes
The `excludeAttributes()` method is used to instruct the action which columns should be excluded from replication:
```php theme={"theme":"gruvbox-dark-hard"}
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:
```php theme={"theme":"gruvbox-dark-hard"}
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:
```php theme={"theme":"gruvbox-dark-hard"}
ReplicateAction::make()
->successRedirectUrl(route('posts.list'))
```
If you want to redirect using the replica, use the `$replica` parameter:
```php theme={"theme":"gruvbox-dark-hard"}
use Illuminate\Database\Eloquent\Model;
ReplicateAction::make()
->successRedirectUrl(fn (Model $replica): string => route('posts.edit', [
'post' => $replica,
]))
```
## 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:
```php theme={"theme":"gruvbox-dark-hard"}
ReplicateAction::make()
->successNotificationTitle('Category replicated')
```
You may customize the entire notification using the `successNotification()` method:
```php theme={"theme":"gruvbox-dark-hard"}
use Filament\Notifications\Notification;
ReplicateAction::make()
->successNotification(
Notification::make()
->success()
->title('Category replicated')
->body('The category has been replicated successfully.'),
)
```
## Lifecycle hooks
Hooks may be used to execute code at various points within the action's lifecycle, like before the replica is saved.
```php theme={"theme":"gruvbox-dark-hard"}
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.
})
```
## Halting the replication process
At any time, you may call `$action->halt()` from inside a lifecycle hook, which will halt the entire replication process:
```php theme={"theme":"gruvbox-dark-hard"}
use App\Models\Post;
use Filament\Notifications\Actions\Action;
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:
```php theme={"theme":"gruvbox-dark-hard"}
$action->cancel();
```
)}
Your logo here