Process controls
Start modes, audience, show-once versioning, skip/close, redirects, and restart button.
Process settings live on each tour (_lcpt_process meta) and control how the tour runs for visitors.
Start modes
| Mode | Behavior |
|---|---|
auto | Start shortly after the page loads (if show-once / audience allow) |
manual | Wait for a button, shortcode, block, or LCProductTour.start |
click | Start when the visitor clicks clickSelector |
hash | Start when the URL hash matches the tour trigger |
Audience
showTo | Who can see the tour |
|---|---|
all | Everyone |
logged_in | Logged-in users only |
guests | Logged-out visitors only |
Show once and version
When show once is enabled (default), completion is stored in localStorage under a key like lcpt_tour_{id}_v{version} (and in user meta for logged-in users via REST).
Bump version when you change steps and want returning visitors to see the tour again.
Force a restart from the console:
LCProductTour.start(123, { force: true });LCProductTour.start(id) defaults to force: true so manual/API starts re-run even after completion. Pass { force: false } to respect show-once.
Close, skip, overlay, keyboard
- allowClose — show dismiss control
- allowSkip — allow skipping ahead
- overlayClick —
close,nextStep, ornone - keyboard — arrow / escape handling
- doneRedirect — optional URL after completion
Restart button
Each tour can enable a floating restart control (position, shape, size, colors, offsets). If the tour leaves restart disabled, site-wide defaults from Product Tours → Settings apply when those defaults are enabled.