OOnboard v2.0.0

Custom merge tags

PHPadd_filter('oob_available_merge_tags', function(array $tags): array {
    $tags['{{plan_name}}'] = 'Customer plan name';
    return $tags;
});

// Then push the value at render time via the context
OOB_Merge_Tags::process('Hello {{plan_name}}', [
    'custom' => ['plan_name' => 'Pro'],
]);

[oonboard id="X"]

Embeds a flow inline on any page or post in Embedded display style.

[oonboard id="42"]

[oonboard_trigger id="X" label="Start"]

Renders a styled button that launches a flow when clicked.

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

PHP helper functions

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

// Queue a flow for a specific user (via OOB_Triggers)
oob_queue_flow( int $flow_id, int $user_id = 0 ): void

// Read a single progress row
oob_get_progress( int $flow_id, int $user_id = 0 ): ?object

OOB_Flow: flow CRUD

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
OOB_Flow::get_variant_b_steps( int $id ): array

OOB_Pro: license + capability gating

PHPOOB_Pro::is_pro(): bool                  // delegated to orravo_is_licensed('oonboard')
OOB_Pro::tier(): string                  // 'free' | 'pro' | 'agency'
OOB_Pro::can( string $feature ): bool    // ab_testing, audience_targeting, webhooks_advanced, etc.
OOB_Pro::free_limit( string $key )       // max_flows: 3, max_steps: 10, allowed step_types: 5

OOB_Skins, OOB_Audience_Evaluator, OOB_Condition_Evaluator

PHPOOB_Skins::get_all(): array                                    // all registered skins
OOB_Audience_Evaluator::matches( int $flow_id, int $user_id ): bool
OOB_Condition_Evaluator::evaluate( array $conditions, int $user_id, array $context = [] ): bool

OOB_Progress: progress tracking

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

OOB_Analytics

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

OOB_Merge_Tags

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

JavaScript API

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

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

oob_progress

Indexes: (user_id, flow_id), (flow_id, status)

oob_events

Indexes: (flow_id, event_type, created_at), (flow_id, step_index, event_type)

oob_flow_versions

Version snapshot per flow save. Restore via OOB_Versions::restore() or the AJAX endpoint oob_restore_version (Pro).

Columns: id, flow_id, version_number, steps_json, settings_json, saved_by, saved_at. Index (flow_id, version_number).

oob_checklists / oob_checklist_progress

Standalone frontend checklist widgets, separate from in-flow checklist steps. oob_checklists stores titles, items, and settings. oob_checklist_progress tracks per-user, per-item completion with a unique key on (checklist_id, user_id, item_index). Rendered in the page footer by OOB_Checklist::inject_widgets().

oob_survey_responses

NPS scores and survey answers. Columns: id, flow_id, step_index, user_id, session_key, question_key, response, score, created_at. Indexes on (flow_id, step_index) and (flow_id, question_key).

oob_webhook_log

Outgoing webhook deliveries with status code, response body, attempt count. Failed deliveries (non-2xx) are auto-retried at 5min, 15min, then 1hr (Pro: webhooks_advanced).

Custom post types

REST API · /wp-json/oonboard/v1/

Frontend AJAX (public + logged-in)

Admin AJAX (requires manage_options)

Actions

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);

Filters