Auto Save
Pimcore Studio automatically saves drafts for Documents and Data Objects. Auto-save triggers on every value change
with an 800ms debounce, creating a version with the autoSave task type.
How it works
- When an editor modifies a document or data object, an auto-save fires after 800ms of inactivity.
- Each auto-save creates a version marked as
isAutoSave = true. These versions are not published and changes remain visible only in the editor until explicitly published. - Auto-save respects element permissions - it only runs if the user has the
savepermission on the element. - If a manual save or publish is triggered while an auto-save is running, the manual operation is queued and executes after the auto-save completes.
Disabling auto-save
Set auto_save_interval to 0 to turn off auto-save for data objects, documents, or both:
pimcore:
objects:
auto_save_interval: 0
documents:
auto_save_interval: 0
With auto-save disabled, changes stay in the editor and are only persisted when the user saves or publishes. Any other value keeps auto-save enabled; Studio still uses the debounce described above, not the configured interval.
Some document editables (for example area blocks, or editables configured with reload: true) need the
server to re-render the page after a change. For those, Studio still stores the current state as an
auto-save version before reloading the editor, even when document auto-save is disabled.
Draft restoration
When opening an element, if a newer auto-save version exists, the detail response includes draft data. The editor can choose to restore or discard the draft.
Publishing and auto-save cleanup
Publishing an element automatically deletes all auto-save versions for the current user. This ensures that stale drafts do not accumulate over time.