Developer Documentation

AJAX Endpoints Reference The admin-ajax actions behind the plugin's interactive features, their nonces, and when to use PHP functions instead. Custom Reward Types Building a bespoke reward: creating a Custom reward type, then running your own fulfilment code when a customer claims it. Developer API functions The supported PHP functions for reading, awarding and spending store credit from your own code. Filter reference Every filter the plugin exposes, what it receives, and the cases each one is meant for. Filter reference Every filter the plugin exposes, what it defaults to, and what changing it affects. Hooks and filters reference Every filter, action, cron event and shortcode the plugin exposes, with defaults and usage notes. Hooks and filters reference All the filters and actions Better Coupon Restrictions provides, with arguments and examples. Hooks, filters and code examples Developer reference for the plugin's filters, actions and helper functions, with code examples for content and player changes. Translating the Plugin Translating the plugin with Loco Translate or your own language files, including how the configurable points labels are handled. Action and filter hooks The actions and filters available for reacting to credit events and changing plugin behaviour. Action hooks reference The action hooks the plugin fires, where they run, and how to use them to add your own content to the reports screen. Action reference Actions fired around rendering and verification, their parameters, and the two you are meant to fire yourself. Add your own restriction check Register a custom coupon check with the bcrw_validation_checks filter and reject coupons using bcrw_fail(). Store keys in wp-config.php Define the OpenAI API key and Dropbox app credentials as wp-config.php constants, and a known limitation in version 3.2.0. Template Overrides Why template files cannot be overridden from a theme, and the hooks and CSS custom properties to use for customising output instead. Where exemption data is stored The user meta, order meta, product meta and settings keys the plugin uses, and how to read them safely under HPOS. Coupon meta keys and stored data Reference of the coupon meta keys, options, database table, cookie and session keys the plugin uses. Data storage and database tables Where balances, vouchers, the activity log and settings are stored, and what uninstalling removes. How report data is compiled Reports read the WooCommerce Analytics lookup tables where they can and walk the orders where they cannot. Here is how that works. Options and post meta reference Developer reference to the options, post meta keys, file paths and AJAX actions the plugin stores or registers, and how to remove them. PHP Functions Reference The PHP functions available to read and change a customer's points, level and referral data from a plugin or theme. Shortcodes and helper functions The four shortcodes, the render and verify helpers, and the supporting functions an integration can call. Actions & Filters Reference The WordPress actions and filters the plugin fires, for changing points, rewards, levels and display output from your own code. Add Turnstile to a custom form Render the widget and verify the token on a form the plugin does not support out of the box. Database tables and meta reference The database table, options and coupon meta keys the plugin creates, and the WooCommerce tables it reads from. How audio generation works Technical walkthrough of how text is prepared, split into chunks, sent to OpenAI and saved as a single MP3 file. PHP API: Custom Ways to Earn Registering your own ways to earn in code with spar_register_custom_earn_way(), and awarding the points from your own triggers. Data stored, cookies and privacy What the plugin stores about customers, the tables and cookies it uses, and the third-party services it relies on.