We're off to DotAll 2022 in Brooklyn NY (plus a little extra sightseeing time). Our support will be limited.

Console Commands#

Formie comes with a number of command line utilities that can be run on-demand, or on a set schedule.

Delete Orphaned Fields#

A cleanup tasks to ensure fields aren't orphaned. Not normally required.

./craft formie/gc/delete-orphaned-fields

Prune Syncs#

A cleanup task to ensure Synced Fields are neat. Not normally required.

./craft formie/gc/prune-syncs

Prune Incomplete Submissions#

Deletes any incomplete submissions that exceed the "Maximum Incomplete Submission Age" plugin setting.

./craft formie/gc/prune-incomplete-submissions

Prune Data Retention Submissions#

Deletes any submissions that exceed your data retention form settings.

./craft formie/gc/prune-data-retention-submissions

Prune Content Tables#

A cleanup task to ensure deleted forms have their content tables also deleted. Not normally required.

./craft formie/gc/prune-content-tables

Prune Content Table Fields#

A cleanup task for content tables to ensure unnecessary field columns are removed. Not normally required.

./craft formie/gc/prune-content-table-fields

Each of the above commands are also run automatically through Craft's Garbage Collection (opens new window), so there's no need to add these commands unless you want fine-grained control over when they run.

Delete Submissions#

You can bulk delete submissions with this command.

OptionDescription
--form-handleThe form handle(s) to delete submissions from. Can be set to multiple comma-separated handles.
--form-idThe form ID(s) to delete submissions from. Can be set to multiple comma-separated IDs.
--incomplete-onlyWhether to delete only incomplete submissions.
--spam-onlyWhether to delete only spam submissions.
./craft formie/submissions/delete --form-handle=form1,anotherForm

Delete Sent Notifications#

You can bulk delete sent notifications with this command.

OptionDescription
--form-handleThe form handle(s) to delete sent notifications for. Can be set to multiple comma-separated handles.
--form-idThe form ID(s) to delete sent notifications for. Can be set to multiple comma-separated IDs.
./craft formie/sent-notifications/delete --form-handle=form1,anotherForm

Migration#

You can run the migrations from either Sprout Forms or Freeform via the command line. This would be an ideal approach if you have a large number of submissions or complex forms to migrate.

Migrate Sprout Forms#

OptionDescription
--form-handleThe Sprout Forms handle(s) to migrate. Can be set to multiple comma-separated handles. Omit to migrate all.
./craft formie/migrate/migrate-sprout-forms --form-handle=form1,anotherForm

Migrate Freeform#

OptionDescription
--form-handleThe Freeform form handle(s) to migrate. Can be set to multiple comma-separated handles. Omit to migrate all.
./craft formie/migrate/migrate-freeform --form-handle=form1,anotherForm

Previous ← GraphQL Next Migrating from Freeform →

Get started with Formie

Available for Craft 4. Get it from the plugin store.