OOnboard v1.0.0

What OOnboard does

Multi-step guided experiences for new users — from simple welcome screens to quiz-driven branching flows with registration gating, video steps, and post-completion automation. Self-hosted, WordPress-native, no monthly SaaS cost.

Getting installed

Your first flow in minutes

Admin interface

Persistent two-row sticky header — brand bar (icon + name + version + light/dark toggle) plus a horizontal tab nav. Theme preference persisted to localStorage under key oob_theme.

Dashboard

Four-stat summary row — Total Flows, Flow Starts, Completions, Avg Completion Rate — followed by a table of recent flows with per-flow conversion stats.

Flows tab

Lists all flows with name, display style, trigger type, status pill (Active / Draft), start count, and completion rate. Actions: Edit (opens Builder), Duplicate, Delete. Live search filters flows by name.

Flow builder

Progress tab

Paginated table of all user interactions. Filter by flow or status. Delete individual records with the trash icon.

Analytics tab

Per-flow analysis. Select a flow from the dropdown to see stats.

Global settings

The Settings tab also shows a Merge Tags Reference and Shortcode Reference panel in-admin.

Ten step types

Four display styles

Set per-flow in Flow Settings. Can also be overridden by the style attribute on the trigger shortcode.

Progress indicators

Flow triggers

Conditional branching

Implemented via the Quiz step type. Each answer option has a next_step_index field that overrides the default sequential next step.

When a user selects an option, OOB_Engine::ajax_complete_step() reads the chosen option's next_step_index and jumps there instead of current_index + 1. If next_step_index is null, the flow advances normally.

Merge tags

Double-brace {{placeholders}} replaced at render time by OOB_Merge_Tags::process(). Work in step title, content, and subheading fields.

PHPadd_filter('oob_merge_tag_context', function($context, $flow_id, $user_id) {
    $context['custom']['plan_name'] = 'Pro';
    return $context;
}, 10, 3);

// Now use {{plan_name}} in any step field

Post-flow actions

Run automatically when a user completes the final step, via OOB_Actions::run(). Configure in Builder → Flow Settings.

JSON · webhook payload{
  "event":   "flow_completed",
  "flow_id": 42,
  "user_id": 7,
  "time":    1745625600
}

A/B testing

Enable per-flow in Builder → Flow Settings → A/B Test checkbox. New users are randomly assigned 50/50 to Variant A (original steps) or Variant B (separate step set).

Shortcodes

[oonboard id="42"]

[oonboard_trigger id="42" label="Start the Tour" style="modal"]

Gutenberg block

OOnboard registers an OOnboard Flow block in the Gutenberg editor under the Widgets category.

Orravo integrations

PHP · OMailer callom_subscribe( $user_email, [
    'first_name' => $user->first_name,
    'last_name'  => $user->last_name,
    'list_id'    => $list_id,
    'source'     => 'oonboard',
] );

Developer API

PHP// Check if the current user has completed a flow
oob_has_completed_flow( int $flow_id, int $user_id = 0 ): bool

// Get the admin builder URL for a flow
oob_get_flow_url( int $flow_id ): string

PHPOOB_Flow::create( string $name, array $settings = [] ): int
OOB_Flow::update( int $id, array $data ): bool
OOB_Flow::delete( int $id ): bool
OOB_Flow::duplicate( int $id ): int
OOB_Flow::get( int $id ): ?WP_Post
OOB_Flow::get_all( array $args = [] ): array
OOB_Flow::get_steps( int $id ): array
OOB_Flow::get_settings( int $id ): array
OOB_Flow::get_post_actions( int $id ): array

PHPOOB_Progress::upsert( int $flow_id, int $user_id, string $session_key ): int
OOB_Progress::update_step( int $flow_id, int $step_index, int $user_id, string $session_key ): void
OOB_Progress::complete( int $flow_id, int $user_id, string $session_key ): void
OOB_Progress::abandon( int $flow_id, int $user_id, string $session_key ): void
OOB_Progress::has_completed( int $flow_id, int $user_id ): bool
OOB_Progress::log_event( int $flow_id, string $event, int $step_index, ... ): void

PHPOOB_Analytics::get_flow_stats( int $flow_id ): array
OOB_Analytics::get_dashboard_totals(): array
OOB_Analytics::get_dropoff_by_step( int $flow_id ): array
OOB_Analytics::get_ab_stats( int $flow_id ): array

PHPOOB_Merge_Tags::process( string $content, array $context = [] ): string
OOB_Merge_Tags::get_available_tags(): array

JS// Programmatically launch a flow
OOBFrontend.launchFlow( flowId, displayStyle );

// Close a running flow
OOBFrontend.closeFlow( flowId );

Database schema

AJAX endpoints

All endpoints registered via wp_ajax_* hooks and require a valid nonce.

Hooks & filters

PHPadd_action('oob_flow_completed', function($flow_id, $user_id, $actions) {
    if ($flow_id === 42) {
        update_user_meta($user_id, 'onboarding_complete', '1');
    }
}, 10, 3);

Frequently asked questions

What's shipped