Docs/Extending WPChangeSync

Extending WPChangeSync

Extend WPChangeSync with integration manifests, handlers, hooks, and workflow-aware behavior.

Updated June 2026·WPChangeSync 2.0

Manifest plus handler architecture

Integrations are described by JSON manifests and executed by handler classes. The sync engine loads active integrations, resolves handlers, and exposes shared export, import, item listing, count, storage path, filename, and workflow option behavior.

What an integration defines

Integration ID, label, category, and UI visibility.
Handler class and active checks.
Storage path and filename pattern.
Whether it appears in workflows.
Default conflict resolution behavior.

Extension points

The engine applies filters before export, fires actions at export start and batch lifecycle moments, and lets integration handlers own data-specific import/export logic. New integrations should keep payloads deterministic and Git-friendly.

Design principle

A new integration should be selective, reversible where possible, explicit about conflicts, and safe to run in a dry-run workflow before production writes.

$pathstringRequired

Absolute path of the directory to write the snapshot to.

$modestringOptionaldefault: two-way

Sync direction — push, pull or two-way.

$gitboolOptionaldefault: false

When true, commits the snapshot to the repository after writing.