Free edition
The free edition has no settings. WooCommerce → Product Add-Ons (capability manage_woocommerce) only explains where options are written.
The three slots
Products → Edit → Product data → General → Product add-ons. Stored as one array in the product meta _gmpaf_addons.
| Field | Default | What it does |
|---|---|---|
| Label | empty | What the shopper reads. An empty label leaves the slot unused. Plain text |
| Type | Text field | Text field (the shopper types up to 200 characters) or Checkbox |
| Fee | 0 | Charged once per cart line when the option is used, whatever the quantity. Rounded to 2 decimals; negative becomes 0 |
- A text option counts as used when the shopper typed something; a checkbox when it is ticked.
- Options are never required in the free edition.
- On a variable product the slots are written on the product itself and apply to every variation.
Full edition
Settings
WooCommerce → Product Add-Ons → Settings. Stored in the option gmpa_settings.
| Label | Key | Default | What it does |
|---|---|---|---|
| Show a running total | show_totals |
on | Shows the product-plus-add-ons subtotal under the fields as the shopper picks |
| Show the total while required fields are empty | show_incomplete_totals |
off | Off by default: an incomplete total can read as a promise |
| Delete all data on uninstall | delete_data |
off | When the plugin is deleted, also remove every add-on, group and setting |
Product add-ons
Products → Edit → Product data → Add-ons. Stored in _gmpa_addons.
- Use global add-ons (on by default; meta
_gmpa_exclude_globalwhen off) — also show the groups that apply store-wide or to this product's categories. - Add a field… — adds a field of the chosen type.
- Import / export — copy the fields as JSON, or paste an exported set and press Append pasted fields.
- Each field has Move up, Move down and Remove.
Field types
| Type | Key | What the shopper does |
|---|---|---|
| Multiple choice | multiple_choice |
Picks one option, shown as a Dropdown, Radio buttons or Image swatches |
| Checkboxes | checkbox |
Ticks any number of options |
| Short text | custom_text |
Types a line |
| Long text | custom_textarea |
Types several lines |
| Customer-defined price | custom_price |
Types an amount to pay |
| Quantity | input_multiplier |
Types a whole number; the price is multiplied by it |
| File upload | file_upload |
Uploads a file |
| Date picker | datepicker |
Picks a date in the browser's own date input |
| Heading | heading |
Nothing — a heading between fields |
Field settings
| Label | Key | Applies to | What it does |
|---|---|---|---|
| Title | name |
All | The field's name. A field with no title is not shown |
| Title format | title_format |
All | Label, Heading or Hidden |
| Display | display |
Multiple choice | Dropdown, Radio buttons, Image swatches |
| Required | required |
All but heading | The product cannot be added until it is filled in |
| Show a description / Description | description_enable, description |
All | Text under the title |
| Show a placeholder / Placeholder | placeholder_enable, placeholder |
Text fields | Hint text inside the box |
| Charge a price / Price / Price type | adjust_price, price, price_type |
Text, quantity, date, upload | A price for the field as a whole |
| Restriction | restrictions, restrictions_type |
Short text | Any text, Only letters, Only numbers, Only letters and numbers, Email address |
| Limit the value / Minimum / Maximum | min, max |
Text (length), Quantity and Customer-defined price (value) | Bounds checked on the server |
| Pre-filled value | default |
Multiple choice, checkboxes, quantity, customer price | The starting value |
| Limit file types | limit_file_types, allowed_file_types |
File upload | Only these extensions; the file's content is also checked |
Options (multiple choice and checkboxes)
| Column | Key | What it does |
|---|---|---|
| Option | label |
The option's text |
| Price type | price_type |
Flat fee, Per quantity, Percentage of the price |
| Price | price |
The amount, or the percentage |
| Image | image |
For image swatches — a media-library image |
| Visible | visibility |
Hide an option without deleting it |
| Default | — | Pre-select this option |
Price types
| Label | Key | Charged |
|---|---|---|
| Flat fee | flat_fee |
Once per cart line, whatever the quantity |
| Per quantity | quantity_based |
Once per unit |
| Percentage of the price | percentage_based |
That percentage of the product's own price, per unit |
Global groups
WooCommerce → Product Add-Ons → Add group. Each group is a gmpa_global_addon post.
| Label | Stored | What it does |
|---|---|---|
| Group name | post title | For you |
| Display order | _gmpa_priority |
Lower renders higher. Per-product fields render at 10 |
| Apply to all products | _gmpa_all_products |
Every product |
| Product categories | product_cat terms |
Products in these categories |
| Fields | _gmpa_addons |
The same editor as on a product |
Import from WooCommerce Product Add-Ons
When the screen finds that plugin's data, it says how many products and global groups can be imported. The import reads the original data and never changes it, works in batches (run it again if more remain) and does not import the same thing twice.
License & updates
Enter the GM-XXXXX-… key from your gatemi.com account and press Activate. If a check cannot reach gatemi.com, the licence state is left unchanged.
