Customizing actions

The package uses action classes for its core operations. You can extend these to customize behavior.

##Available actions

##LogActivityAction

Called every time an activity is logged. Handles description placeholder replacement, transforming changes, calling beforeActivityLogged() on the subject, and saving the activity to the database.

##CleanActivityLogAction

Called by the activitylog:clean command. Handles deleting old activity records.

##Overriding an action

Create a class that extends the original action and override the protected methods you want to customize:

use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Actions\LogActivityAction;

class CustomLogActivityAction extends LogActivityAction
{
    protected function save(Model $activity): void
    {
        // Example: dispatch to queue instead of saving synchronously
        dispatch(fn () => $activity->save());
    }
}

Then register it in the config:

// config/activitylog.php
'actions' => [
    'log_activity' => \App\Actions\CustomLogActivityAction::class,
    'clean_log' => \Spatie\Activitylog\Actions\CleanActivityLogAction::class,
],

##Manipulating changes

To modify the changes array before it's saved (e.g. removing sensitive fields), override transformChanges():

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Arr;
use Spatie\Activitylog\Actions\LogActivityAction;

class RedactPasswordAction extends LogActivityAction
{
    protected function transformChanges(Model $activity): void
    {
        $changes = $activity->attribute_changes?->toArray() ?? [];

        Arr::forget($changes, ['attributes.password', 'old.password']);

        $activity->attribute_changes = collect($changes);
    }
}

##Overridable methods

##LogActivityAction

##CleanActivityLogAction