Documentation

Start with the essentials.

This is the launch documentation shell for the commercial site. It reflects the current v0.5.0 development build and will expand into full setup, API and troubleshooting guides before release.

Requirements

WordPress 6.5 or later
PHP 8.1 or later
WooCommerce 9.0 or later

The plugin declares compatibility with WooCommerce High-Performance Order Storage and Cart & Checkout Blocks.

Basic setup

Create or edit a WooCommerce product, enable the WG competition settings, define the ticket pool and customer limit, configure the closing time and then publish the product.

Use staging when testing a new release. Competition state and order events are operational data and should not be experimented with on a live ticket pool.

Skill questions

The current engine uses a four-answer A-D format. Depending on operator settings, an incorrect answer can either block the purchase or allow the purchase while marking the affected entries as ineligible for the draw.

WG Competition Engine provides workflow tools only. The operator remains responsible for ensuring the competition structure and question satisfy the laws, advertising rules and terms applicable to the operator's jurisdiction.

Instant wins

Instant wins use predetermined ticket numbers. Prize types include site credit, cash, product, competition tickets and other. Records can move through states such as Available, Reserved, Won, Claimed, Ineligible and Review.

Optional TeraWallet integration can automatically fulfil site-credit wins and handle refund-related reversal attempts.

Customer shortcodes

[wgce_my_tickets]
[wgce_my_instant_wins]

Use these on account or customer-information pages to surface ticket and instant-win information inside the site.

Developer hooks

// Fired when an instant win is awarded
wgce_instant_win_awarded($award, $order, $item)

// Fired when an instant win is released
wgce_instant_win_released($instant_win_row, $order, $reason)

Security expectations

Keep WordPress, WooCommerce and WG Competition Engine updated. Use HTTPS, strong administrator passwords and 2FA, remove unused privileged accounts and deploy a reputable WAF/security layer where appropriate.