`).
### Date
Interprets the data (whether a Unix timestamp like `1712743821` or a string like `20240410`) as a date and formats it using your WordPress **Settings → General** date format.
### Number
Formats the custom field value according to your site's locale (e.g., adding thousands separators).
### Boolean
If the custom field stores a true/false value (e.g., `1`/`0`, `true`/`false`, `yes`/`no`, `on`/`off`), this format will render a stylized "Yes" or "No" badge.
## Prefix and Suffix
You can inject static text immediately before or after the custom field value.
- **Prefix Example:** If your field returns `14`, setting a prefix of `Aisle ` will render `Aisle 14`.
- **Suffix Example:** If your field returns `220`, setting a suffix of ` V` will render `220 V`.
## Fallback Value
Not all products will have data for a specific custom field. By default, ProductBay will display an em-dash (`—`) for empty cells. You can change this behavior by entering a custom **Fallback Value**.
## Third-Party Plugin Support
ProductBay's custom field discovery is fully compatible with, and can automatically detect fields registered by:
- Advanced Custom Fields (ACF) & ACF Pro
- Meta Box
- Pods
- JetEngine
(Note: For complex fields like repeating groups or galleries, ProductBay will attempt to render a summarized, flattened string).
---
## Combined Column (Pro)
> Source: https://docs.wpanchorbay.com/productbay/features/combined-column
# Combined Column [Pro] [Since v1.2.0]
The Combined Column allows you to merge multiple disparate data points into a single, clean table cell. This is particularly useful when you want to display dense information without taking up horizontal screen space.
## Use Cases
- **Merging Identifiers:** Display the Product SKU and the Stock Status together (e.g., `SKU: 12345 | In Stock`).
- **Dimensions:** Combine Weight, Length, Width, and Height custom fields into a single "Dimensions" column.
- **Pricing & Rating:** Show the Price and the Star Rating in the same cell.
## Configuration
To set up a Combined Column:
1. Add the **Combined** column from the Column Editor.
2. Under the column settings, enter your **Template Syntax**.
### Sub-Elements Builder
The Combined Column features a drag-and-drop builder interface rather than using complex template tags.
Inside the Combined Column settings, you can:
1. **Add Elements:** Click the "Add Element" dropdown to add any standard column type (Name, Price, SKU, custom fields, etc.) as sub-elements.
2. **Layout Options:** Choose between:
- **Inline:** Elements display side-by-side (flex row). You can optionally define a character or symbol (like `|` or `-`) as a **Separator** between elements.
- **Stacked:** Elements display one below the other (block).
3. **Prefix & Suffix:** Each added sub-element has its own settings, allowing you to easily add text before or after its dynamic value (e.g., Prefix: `SKU: ` or Suffix: ` kg`).
4. **Reorder:** Drag and drop elements up or down in the list to rearrange how they appear in the final output.
---
## Display Customization
> Source: https://docs.wpanchorbay.com/productbay/features/display-customization
# Display Customization
ProductBay gives you granular control over the visual appearance of each table. Every table has its own scoped CSS, so styles never leak between tables.
## Header Styling
| Property | Description | Default |
|----------|-------------|---------|
| **Background Color** | Header row background | `#f0f0f1` |
| **Text Color** | Header text color | `#333333` |
| **Font Weight** | Header font weight (Normal, Bold, Extra Bold) | Bold |
| **Text Transform** | Header text capitalization (Uppercase, Lowercase, Capitalize, Normal) | Uppercase |
## Body Styling
| Property | Description | Default |
|----------|-------------|---------|
| **Background Color** | Body rows background | `#ffffff` |
| **Text Color** | Body text color | `#444444` |
### Alternating Rows (Zebra Striping)
Enable the **Alternate Rows** toggle to apply different background colors to even and odd rows. This improves readability for tables with many rows.
When toggled **on**, two additional color pickers appear:
| Property | Description | Default |
|----------|-------------|---------|
| **Alternate Background** | Background for even rows | `#f9f9f9` |
| **Alternate Text** | Text color for even rows | `#444444` |
When toggled **off**, all rows use the same Body background and text colors.
## Button Styling
The add-to-cart button can be fully customized with both default and hover states:
| Property | Description | Default |
|----------|-------------|---------|
| **Background Color** | Button background | `#2271b1` |
| **Text Color** | Button text | `#ffffff` |
| **Hover Background** | Background on hover | `#135e96` |
| **Hover Text Color** | Text color on hover | `#ffffff` |
## Layout
| Property | Description | Default |
|----------|-------------|---------|
| **Border Style** | Table border style (None, Solid, Dashed) | Solid |
| **Border Color** | Table border color (disabled when border style is None) | `#e5e5e5` |
| **Border Radius** | Toggle on/off + numeric px value for corner rounding | On, `0px` |
| **Cell Padding** | Space inside each cell (Compact, Normal, Spacious) | Normal |
### Border Radius
The border radius has its own **enable toggle**. When off, the table has sharp corners regardless of the px value. When on, you can set a custom pixel value (0–24px).
### Cell Padding Options
- **Compact** — Tight spacing for dense tables
- **Normal** — Standard spacing (default)
- **Spacious** — Extra spacing for readability
## Hover Effects
The **Row Hover Effect** has its own **enable toggle**. When on, rows are visually highlighted when the cursor passes over them.
| Property | Description | Default |
|----------|-------------|---------|
| **Row Hover** | Enable/disable row hover highlighting | Enabled |
| **Hover Background** | Row background on hover | `#f5f5f5` |
| **Hover Text Color** | Row text color on hover | *(inherit)* |
When the toggle is off, the hover color pickers are greyed out.
## Instance-Scoped CSS
Each table generates a unique CSS scope. This means:
- Multiple tables on the same page won't share or override each other's styles
- Table styles won't interfere with your theme's CSS
- Your theme's CSS won't break the table layout
## Live Preview
All design changes are shown in real-time in the preview panel during the [Creation Wizard](/features/creation-wizard). What you see in the preview is exactly what visitors will see on the frontend.
---
## Available Options
> Source: https://docs.wpanchorbay.com/productbay/features/available-options
# Available Options
The **Options Panel** provides comprehensive control over the functionality, display, and user experience of your product tables. Below is a detailed breakdown of all available options categorized by their respective sections.
## Table Controls
Configure core table functionality and user controls.
* **Enable Search Bar**
* **Functionality**: Adds a search input field to the table.
* **Option Type**: Toggle
* **Description**: Allows users to quickly search through products directly within the table.
* **Enable Pagination**
* **Functionality**: Activates pagination for the table.
* **Option Type**: Toggle
* **Description**: Breaks down large product lists into smaller, manageable pages.
* **Products Per Page**
* **Functionality**: Determines the number of items per page limit.
* **Option Type**: Number Input
* **Description**: How many products to display on each page (min: 1, max: 500). Only relevant when pagination or load more styles are active.
* **Pagination Style**
* **Functionality**: Defines how extra products are loaded or navigated.
* **Option Type**: Select Dropdown
* **Sub-options**:
* `Standard (Numbers)`: Classic numbered pagination links at the bottom.
* `Load More Button`: Displays a button to append more products to the current list. [Pro]
* `Infinite Scroll`: Automatically loads more products as the user scrolls down the page. [Pro]
* **Enable Image Lightbox**
* **Functionality**: Adds an interactive image viewer.
* **Option Type**: Toggle
* **Description**: Shows the full-size product image in a popup overlay when a user clicks on the product thumbnail.
---
## Taxonomy & Type Filters
Configure frontend dropdown filters to help users find specific products.
* **Enable Categories Filter**
* **Functionality**: Adds a category filter dropdown.
* **Option Type**: Toggle
* **Description**: Allows users to filter table products by their WooCommerce product categories.
* **Enable Product Type Filter**
* **Functionality**: Adds a product type filter dropdown.
* **Option Type**: Toggle
* **Description**: Allows users to filter the table by basic product types (e.g., Simple, Variable, Grouped).
* **Price Range Filter** [Pro]
* **Functionality**: Adds a slider for price-based filtering.
* **Option Type**: Slider / Range Input
* **Description**: Allows users to dynamically filter products by a specific price range.
---
## Cart Functionality
Configure Add to Cart behavior and selection tracking.
* **AJAX Add to Cart**
* **Functionality**: Toggles AJAX-powered add to cart requests.
* **Option Type**: Toggle
* **Description**: When enabled, adds products to the cart inline without reloading the page. When disabled, the cart button functions as a link that redirect users to the single product page.
* **Show Quantity Selector**
* **Functionality**: Enables quantity adjustment for products.
* **Option Type**: Toggle
* **Description**: Displays a quantity input slider/field next to the Add to Cart button for simple products.
* **Show Clear All Button**
* **Functionality**: Adds a bulk clear control.
* **Option Type**: Toggle
* **Description**: Displays a standalone button to instantly clear or uncheck all selected products currently tracked in the active list.
* **Selected Items View Panel**
* **Functionality**: Enables the floating selected items overview.
* **Option Type**: Toggle
* **Description**: Shows a floating, collapsible panel that displays all the items a user has selected or added to cart, along with their individual quantities.
---
## Variable & Grouped Products
Advanced configuration for complex WooCommerce product types. Some display modes and variations require the PRO plugin.
* **Grouped Products**
* **Functionality**: Defines the display behavior when viewing products containing multiple child simple products.
* **Option Type**: Select Dropdown
* **Sub-options**:
* `Inline Dropdown`: Shows a dropdown allowing the selection of child nested products directly in the row.
* `Popup Modal`: Opens a modal displaying all child products within the group. [Pro]
* `Nested Rows`: Renders child products directly in expandable rows nested under the parent product. [Pro]
* `Separate Rows`: Displays the child products in the main table layout, separated into standard individual rows. [Pro]
* **Variable Products**
* **Functionality**: Defines the display behavior for products with attribute variations.
* **Option Type**: Select Dropdown
* **Sub-options**:
* `Inline Dropdown`: Supported natively. Allows variations selection through inline dropdown elements on the parent row.
* `Popup Modal`: Opens a targeted popup to easily select exact variations. [Pro]
* `Nested Rows`: Variations are displayed logically beneath the main product row as sub-rows. [Pro]
* `Separate Rows`: Every variation gets injected as a completely separate row entity. [Pro]
* **Expand Nested Rows**
* **Functionality**: Determines initial state for nested products.
* **Option Type**: Toggle
* **Dependancy**: Only available when `Nested Rows` is selected as a Group or Variable display mode.
* **Description**: Show nested variation/child rows expanded by default instead of having them initially collapsed. AJAX Add to Cart
* **Show Options Count**
* **Functionality**: Displays the total count of variation options.
* **Option Type**: Toggle
* **Description**: Renders an "X options available" subtitle directly below the main product name to clarify variant availability.
* **Variation Badges**
* **Functionality**: Highlighting tracked cart configurations.
* **Option Type**: Toggle
* **Description**: Shows visual badges indicating exactly which variations have been added to the active cart flow.
---
## Import / Export (Pro)
> Source: https://docs.wpanchorbay.com/productbay/features/import-export
# Import & Export [Pro] [Since v1.2.0]
ProductBay Pro includes a robust Import/Export utility that allows you to back up, migrate, and share your table configurations across different WordPress installations using simple JSON files.
You can access these tools by navigating to **ProductBay → Tables → Import / Export**.
1. Click on the **Export** button to open export modal.
2. You can select one or more tables and click on the **Export Selected** unders Actions and click Apply to open Export Modal with those table selected.
3. Click on the **Import** button to open import modal.
## Exporting Tables
The Export tool generates a `.json` file containing all configuration data for your selected tables.
### How to Export:
After clicking on the **Export** button you will see the Export Modal.
1. You can select **Plugin Global Settings** at the top to include your configuration under the General and Styling settings tabs.
2. You can select specific tables to export by checking the checkbox next to each table.
3. You can **Select All** or **Deselect All** tables using the buttons at the top.
4. Click on the **Generate Export** button to generate the export file. A `productbay-export-[date].json` file will download to your device.
## Importing Tables
The Import tool allows you to upload a previously exported `.json` file to restore or migrate tables.
### How to Import:
After clicking on the **Import** button you will see the Import Modal.
1. Under the **Import** section, browse for your `.json` export file.
2. Select an **Overlap Handling Mode** (see below).
3. Choose whether to **Import Global Settings** (if they exist in the file). *Warning: This will overwrite your current global settings.*
4. Click the **Import Tables** button.
1. Click on the upload box or drag and drop your `productbay-export-[date].json` file that you exported earlier into the box.
2. Select how to manage **Conflict Resolution**.
3. **Rename Imported**: If enabled, it will appends "(Imported)" to titles of imported tables.
4. Click the **Start Import** button.
### Conflict Resolution
- **Create New (Keep both):** If two tables have the same configuration, it will create a new table with the imported configuration, keeping your existing table as well.
- **Overlap Existing:** If two tables have the same configuration, it will update the existing table with the imported configuration.
- **Skip Duplicates:** If two tables have the same configuration, it will skip the import process for that table.
## Cross-Site Product Matching
While importing tables to a different website, you may encounter an issue where the product IDs do not match (e.g., Product ID `10` on your staging site might be an orange, but ID `10` on production might be an apple), this mostly happens when you are importing with **Specific Products** source. This is because each website has its own set of product IDs.
**ProductBay Pro's Smart Matching:**
During the import process, ProductBay attempts to resolve this issue automatically:
1. **SKU Matching:** It first tries to find a product on the new site with the exact same SKU.
2. **Title Matching:** If no SKU matches, it attempts to find a product with the exact same title.
3. If neither matches, that specific product condition is dropped from the imported table to prevent errors.
## Use Cases
- **Staging to Production:** Build your perfect tables on a staging server and migrate them to your live server without rebuilding them from scratch.
- **Cross-site Syncing:** Agencies can build a master configuration and import it across multiple client sites.
- **Safe Backups:** Export your table configurations before making major changes.
---
============================================================
SECTION: FEATURES — FRONTEND
============================================================
## WooCommerce Integration
> Source: https://docs.wpanchorbay.com/productbay/features/woocommerce
# WooCommerce Integration
ProductBay is built as a WooCommerce extension, providing deep integration with WooCommerce's product system, cart, and checkout.
## Supported Product Types
| Product Type | Support | Notes |
|-------------|---------|-------|
| **Simple** | Full | Standard add-to-cart with quantity |
| **Variable** | Full | Inline attribute selectors (Free) or Popup/Nested/Separate rows (Pro) |
| **Grouped** | Full | Inline dropdown (Free) or Popup/Nested/Separate rows (Pro) |
| **External / Affiliate** | Full | "Buy Now" button linking to external URL |
## Add to Cart
### AJAX Add to Cart
When enabled, products are added to the cart **without a page reload**. A success message appears inline, confirming the item was added.
This provides a seamless shopping experience, especially for tables with many products.
### Quantity Selector
Enable per-row quantity inputs so customers can specify how many units to add. The input respects WooCommerce's min/max and step settings for each product.
### Bulk Add to Cart
ProductBay supports adding multiple products at once:
1. Enable the checkbox column by turning on cart features
2. Customers select multiple products using checkboxes
3. Click the "Add Selected to Cart" button
4. All selected products are added in a single AJAX request
> **Tip: Bulk add-to-cart works with simple products. Variable products need their attributes selected individually before they can be added.**
>
### Variation Badges
When enabled, small badges appear on each row indicating which specific variations have been added to the cart. This helps customers keep track of their selections without opening the cart.
Toggle **Variation Badges** in the **Options** step under **Cart Functionality**.
### Show Clear All Button
When bulk selection is active, a **Clear All** button can be shown to instantly deselect all currently selected products. This saves customers from having to individually uncheck each product.
Toggle **Show Clear All Button** in the **Options** step under **Cart Functionality**.
### Selected Items View Panel
A floating panel that displays all currently selected items with their individual quantities. This gives customers a running summary of what they're about to add to cart before clicking the bulk action button.
Toggle **Selected Items View Panel** in the **Options** step under **Cart Functionality**.
## Variable Products
By default, ProductBay displays variable products using inline attribute selectors:
- **Dropdowns** appear for each attribute (e.g., Size, Color)
- Selecting attributes updates the **price** in real-time
- The **Add to Cart** button activates once all required attributes are selected
- **Out of stock** variations are automatically disabled
### Advanced Variable Modes [Pro] [Since v1.2.0]
ProductBay Pro unlocks **3 additional display modes** for variable products, allowing for a vastly superior shopping experience:
1. **Popup Modal:** Opens a full-featured modal where customers can see all variations, select quantities, and add multiple variations at once using bulk selection.
2. **Nested Rows:** Expandable child rows that display all variations directly below the parent row.
3. **Separate Rows:** Each variation is split into its own independent row in the main table.
[Read the Advanced Modes guide →](/features/variable-grouped-modes)
## Grouped Products
Grouped products are displayed using an **Inline Dropdown** by default. [Since v1.3.0] Customers can select a child product from the dropdown, set a quantity, and add to cart — all without leaving the table.
### Advanced Grouped Modes [Pro] [Since v1.2.0]
ProductBay Pro allows you to display grouped products directly within the table using 3 additional modes:
1. **Popup Modal:** A full modal listing all child products for easy selection.
2. **Nested Rows:** Expandable child rows containing grouped items underneath the parent.
3. **Separate Rows:** Treats each child product as a separate standalone table row.
[Read the Advanced Modes guide →](/features/variable-grouped-modes)
## Show Options Count
When enabled, a subtle **"X options available"** subtitle appears below the product name for Variable and Grouped products. This gives customers a quick indication of how many choices are available without expanding anything.
Toggle **Show Options Count** in the **Options** step under **Variable & Grouped Products**.
## Price Display
Prices are rendered using WooCommerce's native formatting:
- **Currency symbol** and position (before/after)
- **Decimal separator** and thousand separator
- **Sale prices** shown with strikethrough on the regular price
- **Variable price ranges** (e.g., "$10.00 – $25.00") when no variation is selected
## Cart URL
After adding a product to cart, a "View Cart" link appears, directing customers to the WooCommerce cart page.
---
## Variable & Grouped Modes (Pro)
> Source: https://docs.wpanchorbay.com/productbay/features/variable-grouped-modes
# Variable & Grouped Product Modes [Pro] [Since v1.2.0]
ProductBay Pro transforms how your customers interact with complex products (Variable and Grouped). You can configure display modes per-table in the creation wizard under **Step 4: Options**.
## Variable Product Modes
Variable products contain multiple variations (e.g., a T-shirt available in different sizes and colors).
### Inline Dropdown (Default / Free)
Attribute dropdowns are embedded directly in the main table row. Selecting all attributes calculates the price, and the customer can add exactly one variation to the cart at a time.
### Popup Modal [Pro]
When the customer clicks "Select Options", a sleek modal overlay appears:
- Every variation is listed as a separate row in the modal.
- Customers can adjust quantities for multiple variations simultaneously.
- **Bulk Selection:** Select All checkboxes allow customers to quickly add all desired variations to their cart in a single click.
- The modal automatically adopts your main table's styling settings.
### Nested Rows [Pro]
A "toggle" button is added to the parent product row. When clicked, it expands via AJAX to reveal a nested sub-table showing all variations.
#### Expand by Default
By default, nested rows are collapsed and require the customer to click to expand. You can change this by enabling **Expand Nested Rows by Default** in the Options step. When enabled, all nested sub-tables are shown in their expanded state on initial page load.
### Separate Rows [Pro]
Each variation is forcefully detached from the parent product and rendered as an entirely independent row in the main table. The parent product is hidden, and its children appear alongside simple products. This is excellent for hardware stores or catalogs where every SKU needs instant visibility.
---
## Grouped Product Modes
Grouped products are collections of related simple products sold together (e.g., a "Complete Bed Set" that includes pillows, sheets, and a comforter).
### Inline Dropdown (Default / Free) [Since v1.3.0]
A dropdown selector is added to the table row, allowing customers to select a child product, set a quantity, and add to cart — all without leaving the table.
### Popup Modal [Pro]
Similar to the variable product modal, clicking the parent button opens an overlay listing all child products with their individual checkboxes, quantities, and direct add-to-cart buttons.
### Nested Rows [Pro]
The grouped product acts as a collapsible container. Clicking it drops down a nested table showing all child items, keeping the main table view clean while providing instant drill-down access.
#### Expand by Default
Same as Variable nested rows — enable **Expand Nested Rows by Default** in Options to have grouped nested rows start expanded.
### Separate Rows [Pro]
Breaks the group apart completely, rendering each child item as its own row in the main table.
---
## Search & Filters
> Source: https://docs.wpanchorbay.com/productbay/features/search-and-filters
# Search & Filters
ProductBay includes built-in frontend search, filtering, and pagination — all powered by AJAX for a seamless, no-reload experience.
## Search
When search is enabled, a search bar appears in the main toolbar above the table. Customers can type to search products by:
- **Product name** — Partial or full match
- Results update instantly as the user types (with a debounce delay)
- Search is case-insensitive
> **Info: Search operates on the products loaded by the table's [product source](/features/product-sources). It does not search your entire WooCommerce catalog — only the products that match the table's source configuration.**
>
## Category Filter
When enabled, a category filter dropdown appears in the dedicated Filter Bar above the main table tools.
- Select a product category to filter the table
- Clear the filter to show all products again
- Combine filtering with search for precise results
### Configuration
Enable the category filter in the **Options** step of the [Creation Wizard](/features/creation-wizard#step-4-options):
1. Under **Taxonomy & Type Filters**, toggle **Enable Categories Filter** to on
## Product Type Filter [Since v1.2.0]
A separate toggle adds a **Product Type** dropdown to the frontend Filter Bar, allowing customers to filter by WooCommerce product type:
- **Simple** — Standard products
- **Variable** — Products with attribute variations
- **Grouped** — Products containing child items
- **External** — Affiliate or external products
### Configuration
Enable the product type filter in the **Options** step:
1. Under **Taxonomy & Type Filters**, toggle **Enable Product Type Filter** to on
## Pagination
When pagination is enabled, products are split across multiple pages with navigation controls at the bottom of the table.
### Configuration
| Setting | Options | Default |
|---------|---------|---------|
| **Enable Pagination** | On / Off | On |
| **Products per page** | Any number (1–500) | 10 |
| **Pagination Style** | Standard, Load More [Pro], Infinite Scroll [Pro] | Standard |
### Pagination Styles
#### Standard (Numbers)
The default mode. Numbered page buttons appear at the bottom of the table, allowing customers to jump between pages.
#### Load More Button [Pro]
Replaces page numbers with a single **"Load More"** button. Clicking it appends the next batch of products below the existing rows without replacing them.
#### Infinite Scroll [Pro]
Products load automatically as the customer scrolls down, creating a seamless, never-ending browsing experience. No buttons or page numbers needed.
## Image Lightbox
When enabled, clicking a product's thumbnail image opens a **full-size popup** of the image with a smooth zoom animation. This lets customers inspect product photos without leaving the table.
### Configuration
Toggle **Enable Image Lightbox** in the **Options** step under **Table Controls**. Enabled by default.
## Price Range Filter [Pro] [Since v1.2.0]
ProductBay Pro includes a powerful price filter that allows customers to refine products by an exact price range. It can display as a dual-handle slider, number inputs, or both. The filter auto-detects the minimum and maximum prices of the products in your table.
[Read the full Price Filter guide →](/features/price-filter)
## Feature Toggles
All frontend features can be individually enabled or disabled in the **Options** step:
| Feature | Default | Description |
|---------|---------|-------------|
| **Search** | ✅ On | AJAX search bar |
| **Pagination** | ✅ On | Paginated results |
| **Image Lightbox** | ✅ On | Full-size image popup on click |
| **Categories Filter** | ✅ On | Category dropdown filter |
| **Product Type Filter** | ✅ On | Product type dropdown filter |
| **Price Filter** [Pro] | ❌ Off | Price range slider and inputs |
Configure these in the **Options** step of the [Creation Wizard](/features/creation-wizard).
---
## Price Filter (Pro)
> Source: https://docs.wpanchorbay.com/productbay/features/price-filter
# Price Range Filter [Pro] [Since v1.2.0]
The Price Range Filter allows your customers to zero in on products that fit their budget. Built to be lightning-fast, it uses AJAX to update the table instantly as the user drags the slider or types a price.
## Enabling the Filter
To enable the price filter:
1. Navigate to Step 4 (**Options**) in the creation wizard.
2. Toggle **Price Filter** to the `On` position.
3. The Price Filter settings panel will appear.
## Display Modes
You can choose how the filter is presented to the user. There are 3 display modes:
- **Both (Default):** Combines the visual slider with the precision of number inputs.
- **Slider:** Shows a sleek, dual-handle range slider. Customers drag the handles to set their min and max budget. Hovering over a handle displays a tooltip with the current value.
- **Input:** Shows two simple number input fields (Min and Max).
## Custom Bounds (Min / Max)
By default, ProductBay Pro automatically scans the products in your table and dynamically sets the minimum and maximum limits of the slider based on the cheapest and most expensive items currently available.
If you prefer, you can override this behavior by entering fixed **Min Price** and **Max Price** values in the configuration panel.
## Step Size
The step size dictates how large the increments are when sliding the handle.
- The default step size is `1`.
- If you sell very expensive items (e.g., cars, properties), you might want to set the step size to `100` or `1000`.
- If you want fractional precision, you can set it to `0.50` or `0.01`.
## How it Works
When the filter is applied, ProductBay Pro intercepts the query and applies a standard WordPress meta query against the WooCommerce `_price` meta key. This happens instantly via AJAX without page reloads, and it works flawlessly with all product sources (categories, specific IDs, sale products, etc.).
---
============================================================
SECTION: FEATURES — SETTINGS
============================================================
## Default Configuration
> Source: https://docs.wpanchorbay.com/productbay/features/default-configuration
# Default Configuration
ProductBay allows you to define global defaults that serve as the starting point for every new table you create. These settings ensure consistency across your site and save time during the creation process.
Access these settings from **ProductBay → Settings → Default Configuration** tab.
## Default Source
Configure the default data source settings that will be pre-selected while creating a new table each time.
- **Source Type**: Choose between All Products, Category, On Sale, or Specific Products.
## Default Columns
Define which columns should be enabled by default for new tables. You can select from:
- Image
- Name
- Price
- SKU
- Summary
- Stock [v1.2.0+]
- Date [v1.2.0+]
- Taxonomy [v1.2.0+]
- Rating [v1.2.0+]
- Custom Field (Pro) [v1.2.0+]
- Combined Column (Pro) [v1.2.0+]
## Bulk Select
Configure the default state and behavior of the bulk selection feature, allowing customers to add multiple products to the cart at once.
## Default Styling
Set the factory-default look and feel. These styles will be applied to every new table unless overridden in the **Display** step of the wizard.
#### **Colors**
Personalize the table's color scheme.
- **Add to Cart Button Color**: Change the background and text color of the primary action button.
- **Table Header Color**: Set the background color for the table's header row.
- **Table Rows Color**: Set the default background color for rows.
- **Alternating Rows Color**: Apply a different color to every other row for better readability.
- **Row Hover Color**: Define the color when a user hovers their cursor over a row.
#### **Layout & Spacing**
Adjust the structural feel of the table.
- **Border Style**: Choose from solid, dashed, or no border.
- **Border Color**: Set the color of the table and cell borders.
- **Border Radius**: Round the corners of your table for a softer look.
- **Cell Padding**: Control the space between the content and the cell borders.
#### **Typography**
Fine-tune the text appearance for the header.
- **Header Font Weight**: Choose between Normal, Bold, or Extra Bold.
- **Header Text Transform**: Set text to Uppercase, Lowercase, Capitalize, or leave as Normal.
## Default Functionality
Configure which features are enabled by default:
#### **Table Controls**
- **Enable Search Bar**: Allow users to filter products via a search input.
- **Enable Pagination**: Break long lists into multiple pages.
- **Enable Image Lightbox**: Open full-size images in a popup on click.
#### **Pagination Settings**
- **Products Per Page**: Define how many products are shown before pagination kicks in.
- **Pagination Style**: Choose Standard (numbers), Load More [Pro], or Infinite Scroll [Pro].
#### **Taxonomy & Type Filters**
- **Enable Categories Filter**: Show a category dropdown filter above the table.
- **Enable Product Type Filter**: Show a product type filter dropdown.
#### **Cart Functionality**
- **Enable Add to Cart**: Show add-to-cart buttons.
- **AJAX Add to Cart**: Add to cart without page reload.
- **Show Quantity Selector**: Allow quantity input per row.
- **Variation Badges**: Show badges for variations added to cart.
- **Show Clear All Button**: Display a bulk deselect button.
- **Selected Items View Panel**: Show a floating summary of selected items.
#### **Variable & Grouped Products**
- **Variable Product Mode**: Inline Dropdown (Free), Popup Modal [Pro], Nested Rows [Pro], Separate Rows [Pro].
- **Grouped Product Mode**: Inline Dropdown (Free), Popup Modal [Pro], Nested Rows [Pro], Separate Rows [Pro].
- **Show Options Count**: Display "X options available" subtitle.
- **Expand Nested Rows** [Pro]: Start nested rows expanded by default.
---
## Reset to Defaults
After making any changes, if you decide to reset back default settings, you can do so by clicking **Reset Defaults** button at the top.
---
## Plugin Settings
> Source: https://docs.wpanchorbay.com/productbay/features/plugin-settings
# Plugin Settings
Plugin-wide configuration options that control administrative behavior, data persistence, and system-level maintenance.
Access these settings from **ProductBay → Settings**.
## Plugin Settings Tab
This tab contains plugin-wide configurations that control administrative behavior.
### Admin Bar Options
Control the visibility of the ProductBay quick-access link in the WordPress admin topbar.
- **Show Admin Bar**: When enabled, a "ProductBay" menu appears in the topbar, providing quick links to "Product Tables" and "Create New Table".
[Learn more about admin bar](/guide/admin-bar.html)
## Uninstall Options
Determine what happens to your data when the ProductBay plugin is deleted from your WordPress site.
- **Delete on Uninstall**:
- **Enabled**: All tables, configurations, and settings will be permanently removed from the database on deletion.
- **Disabled**: Plugin data is preserved, allowing you to pick up where you left off if you reinstall later.
> **Warning: Data Permanence**
> We recommend keeping this **Disabled** unless you are certain you want to perform a completely clean removal of all ProductBay data.
[Learn more about uninstall](/guide/uninstallation.html)
## Clear Data (Reset)
ProductBay includes a master reset tool to restore the plugin to its factory state.
### What gets cleared?
1. **Tables**: All created tables are permanently deleted.
2. **Metadata**: All configuration data associated with those tables is removed.
3. **Settings**: All global and default configurations are reset to factory defaults.
4. **Onboarding**: The "Welcome Wizard" state is reset, and it will appear again on the next visit.
> **Danger: Irreversible Action**
> Resetting data is **permanent** and cannot be undone. Always ensure you have a database backup before performing a full reset.
[Learn more about clear data](/guide/clear-all-data.html)
---
## Activity Log
> Source: https://docs.wpanchorbay.com/productbay/features/activity-log
# Activity Log [Since v1.3.0]
ProductBay includes a powerful, built-in recording system that tracks important actions like table creation, setting updates, and system events. This helps you monitor changes, audit user actions, and troubleshoot issues without checking server-level logs.
## Overview
The Activity Log is a diagnostic tool that provides transparency into how your product tables are being managed. It records:
- **Major Events**: Table creation, updates, and deletions.
* **Administrative Actions**: Global settings changes, licensing updates, and log clearing.
- **System Events**: Background tasks like log pruning and automatic data cleanup.
## Managing Logs
You can access the log viewer by navigating to **ProductBay > Settings > Activity Log**.
### Enabling & Disabling
Logging is enabled by default. To change this:
1. Click the **Gear Icon (⚙️)** in the top-right of the Log Viewer.
2. Toggle the **Enable Logging** switch.
3. Click **Save & Close**.
### Live Mode
For real-time monitoring, you can enable **Live Mode** in the settings modal. When active, the log list will automatically refresh every 10 seconds to show new entries as they happen.
### Exporting Logs
If you need to share your logs with support or analyze them externally:
1. Click the **Export** button in the header.
2. Choose a range: **Day**, **Week**, or **Month**.
* The system will automatically combine all relevant daily files into a single download.
### Clearing History
To permanently remove all recorded logs:
1. Click the **Trash Icon (🗑️)** in the header.
2. Confirm the action in the popup.
> [!WARNING]
> This action is permanent and cannot be undone.
## Troubleshooting
If you see an **Error** level entry in your logs, click the entry to see the full details. ProductBay often captures technical environment data (like PHP version and system state) during errors to help developers identify the root cause faster.
---
## License
> Source: https://docs.wpanchorbay.com/productbay/features/license
# License [Since v1.2.0]
The **License** tab, found under **ProductBay → Settings**, is the control center for your ProductBay Pro subscription.
Depending on your active plugin, this tab displays different content:
## Free Version
If you are using the free version of ProductBay, this tab serves as an overview of what **ProductBay Pro** unlocks. It shows:
- A promotional view highlighting premium features (like Custom Fields, Combined Columns, and Advanced Variable Modes).
- A quick link to upgrade to the Pro version.
## Pro Version
Once you install and activate the Pro version, this tab transforms into your license management center. It allows you to:
- Enter and activate your license key to unlock the Pro features.
- View your current license status (Active, Expired, Invalid).
- Check your license expiration dates.
- Manage site activations (useful if you are changing URLs or migrating from staging to live).
## Activating Your License
To gain access to premium features, fast support, and automatic updates directly from your WordPress dashboard, you must activate your license key.
### Finding Your License Key
After [purchasing ProductBay Pro](https://wpanchorbay.com/plugins/productbay/), your license key will be available in two places:
1. **Purchase Email:** The confirmation email sent to the address you provided during checkout.
2. **Account Dashboard:** Log in to your account on [WPAnchorBay](https://wpanchorbay.com/my-account/) and navigate to the **Licenses** tab.
### Activation Steps
To activate your license and enable Pro features:
1. In your WordPress admin, go to **ProductBay → Settings**.
2. Click on the **License** tab.
3. Paste your license key into the input field.
4. Click the **Activate** button.
Once successfully activated, the status will change to "License Active" and display the expiration date.
### Removing License
If needed, you can remove your license by going to **Settings → License**, where you’ll find the **Remove License** button.
Once removed, the license must be activated again to continue using Pro features. You can reactivate it using the same license key.
Note: Removing a license from one site does not allow you to use it on a different site.
## License Status Indicators
Your license tab will display one of the following statuses:
- **Active:** Your license is valid, and you have full access to features and updates.
- **Expired:** Your subscription has ended. You'll lose access to automatic updates and premium support, but the plugin will continue to function.
- **Invalid / Deactivated:** The key is incorrect or has been deactivated from this site.
## Moving a License
When a license is activated for the first time, it becomes locked to that specific domain. To transfer the license to a different website, you will need to contact the support team for assistance.
## Automatic and Manual Updates
**Automatic Updates:**
ProductBay Pro integrates seamlessly with the standard WordPress update system. Whenever a new version is released, you will see an update notification on the **Plugins** page, provided your license is active.
**Manual Updates:**
If you prefer not to use automatic updates or your license has expired:
1. Download the latest `productbay-pro.zip` from your WPAnchorBay account.
2. Upload the zip in WordPress via **Plugins → Add New → Upload Plugin**.
3. Overwrite the existing plugin when prompted.
## Troubleshooting
- **Firewall Blocking License Server:** Ensure your hosting environment doesn't block outgoing connections to the WPAnchorBay license server. This is required to validate the key.
- **Domain Mismatch:** Once you activate your license, your domain is locked to that license. So you can't use the same license key on two different domains. If you change your domain name, you may need to contact us to reactivate the license key on new domain.
- **"Requires ProductBay Free Version" Notice:** ProductBay Pro requires the free version of ProductBay (v1.2.0 or higher) to be active simultaneously. Please install and activate the free version of ProductBay to use ProductBay Pro.
---
============================================================
SECTION: DEVELOPER REFERENCE
============================================================
## Architecture
> Source: https://docs.wpanchorbay.com/productbay/developer/architecture
# Architecture
This page provides a technical overview of ProductBay's internal architecture. It's intended for developers who want to understand how the plugin is built or contribute to it.
## High-Level Architecture
ProductBay follows a **Hybrid Architecture** pattern:
```
┌──────────────────────────────────────────────────────────┐
│ WordPress Core │
├────────────────────────┬─────────────────────────────────┤
│ Admin (React SPA) │ Frontend (PHP Render) │
│ │ │
│ React 18 + TypeScript │ TableRenderer + AjaxRenderer │
│ Tailwind CSS v4 │ Pure PHP + minimal jQuery │
│ Zustand State │ Scoped CSS per instance │
│ React Router (Hash) │ SEO-friendly HTML │
│ │ │
│ ┌──────────────────┐ │ ┌───────────────────────────┐ │
│ │ REST API │◄─┼──│ Shortcode System │ │
│ │ /productbay/v1 │ │ │ [productbay id="X"] │ │
│ └────────┬─────────┘ │ └───────────────────────────┘ │
│ │ │ │
├───────────┼────────────┴─────────────────────────────────┤
│ ▼ │
│ ┌─────────────────┐ ┌──────────────────────────────┐ │
│ │ Controllers │ │ TableRepository │ │
│ │ (API Layer) │──│ (Data Layer / CPT) │ │
│ └─────────────────┘ └──────────────────────────────┘ │
└──────────────────────────────────────────────────────────┘
```
## Backend (PHP)
### Directory Structure
```
app/
├── Admin/ # WP admin page registration, asset enqueuing
├── Api/ # REST API controllers
│ ├── ApiController.php # Base controller
│ ├── TablesController.php # Table CRUD operations
│ ├── ProductsController.php # Product search & categories
│ ├── SettingsController.php # Plugin settings management
│ ├── SystemController.php # System status & onboarding
│ └── PreviewController.php # Live preview rendering
├── Core/ # Plugin bootstrapper, activation/deactivation
├── Data/ # Data repositories (TableRepository)
├── Frontend/ # Shortcode, TableRenderer, AjaxRenderer
├── Http/ # Router (REST route registration), Request wrapper
└── Utils/ # Utility classes
```
### Key Classes
| Class | Responsibility |
|-------|---------------|
| `Core\Plugin` | Main plugin bootstrapper — initializes all components |
| `Http\Router` | Registers all REST API routes with permission checks |
| `Http\Request` | Wraps `$_REQUEST` with sanitization helpers |
| `Data\TableRepository` | CRUD operations for the `productbay_table` custom post type |
| `Frontend\Shortcode` | Registers `[productbay]` shortcode and triggers rendering |
| `Frontend\TableRenderer` | Generates the full HTML table from table config |
| `Frontend\AjaxRenderer` | Handles AJAX requests (search, filter, pagination, add-to-cart) |
### Data Storage
- **Tables** are stored as a custom post type (`productbay_table`)
- **Table configurations** are stored in post meta (`_productbay_config`)
- **Plugin settings** are stored in `wp_options` (`productbay_settings`)
## Frontend (React/TypeScript)
### Directory Structure
```
src/
├── components/ # Reusable UI components
├── context/ # React context providers
├── hooks/ # Custom React hooks
├── layouts/ # Page layout wrappers
├── pages/ # Main page components
│ ├── Dashboard.tsx # Welcome/onboarding dashboard
│ ├── Tables.tsx # Product Tables list view
│ ├── Table.tsx # Table creation/edit wizard
│ └── Settings.tsx # Plugin settings page
├── store/ # Zustand state stores
├── styles/ # Tailwind CSS entry point
├── types/ # TypeScript type definitions
└── utils/ # Utility functions
```
### Tech Stack
| Technology | Purpose |
|-----------|---------|
| React 18 | UI library (via `@wordpress/element`) |
| TypeScript | Type-safe JavaScript (ES2020, strict mode) |
| Tailwind CSS v4 | Utility-first styling, scoped to `#productbay-root` |
| Zustand | Lightweight state management |
| React Router DOM v7 | SPA routing (HashRouter) |
| Lucide React | Icon library |
| dnd-kit | Drag-and-drop for column reordering |
## Build System
| Tool | Purpose |
|------|---------|
| Webpack | Module bundler (extends `@wordpress/scripts`) |
| `@wordpress/scripts` | WP build toolchain (JS/TS transpilation) |
| `@tailwindcss/cli` v4 | CSS compilation |
| Bun | Package manager and script runner |
| Composer | PHP dependency management (PSR-4 autoloading) |
---
## REST API
> Source: https://docs.wpanchorbay.com/productbay/developer/rest-api
# REST API
ProductBay registers its own REST API endpoints under the `productbay/v1` namespace. All endpoints require the `manage_options` capability (WordPress administrator).
> **Warning: Internal API**
> These REST API endpoints are used internally by the ProductBay admin panel. They are not intended as a public API and may change in future versions. Do not build external integrations against these endpoints.
## Authentication
All endpoints require:
- The user to be **logged in** to WordPress
- The user to have the **`manage_options`** capability
- A valid **WordPress REST API nonce** (handled automatically by the admin panel)
## Base URL
```
/wp-json/productbay/v1/
```
## Endpoints
### Tables
#### List Product Tables
```http
GET /wp-json/productbay/v1/tables
```
Returns an array of all ProductBay tables with their metadata.
**Response:**
```json
[
{
"id": 1,
"title": "All Products",
"status": "publish",
"source": { "type": "all" },
"shortcode": "[productbay id=\"1\"]",
"created": "2026-01-15T10:30:00",
"modified": "2026-01-20T14:22:00"
}
]
```
--------|------|-------------|
| `id` | integer | Table post ID |
---
#### Create / Update Table
```http
POST /wp-json/productbay/v1/tables
```
Creates a new table or updates an existing one. Send the full table configuration in the request body.
| Body Parameter | Type | Description |
|---------------|------|-------------|
| `data` | object | Complete table configuration (title, source, columns, style, settings) |
---
#### Delete Table
```http
DELETE /wp-json/productbay/v1/tables/{id}
```
Permanently deletes a table.
| Parameter | Type | Description |
|-----------|------|-------------|
| `id` | integer | Table post ID |
---
### Products
#### Search Products
```http
GET /wp-json/productbay/v1/products
```
Search WooCommerce products by name, ID, or SKU.
| Parameter | Type | Description |
|-----------|------|-------------|
| `search` | string | Product name search (fuzzy match) |
| `include` | integer | Exact product ID |
| `sku` | string | SKU exact or prefix match |
| `limit` | integer | Results per page (default: 10) |
| `page` | integer | Page number (default: 1) |
---
#### List Categories
```http
GET /wp-json/productbay/v1/categories
```
Returns all WooCommerce product categories.
**Response:**
```json
[
{
"id": 15,
"name": "Clothing",
"count": 42,
"slug": "clothing"
}
]
```
---
#### Source Statistics
```http
GET /wp-json/productbay/v1/source-stats
```
Returns product and category counts for a source type.
| Parameter | Type | Description |
|-----------|------|-------------|
| `type` | string | Source type: `all` or `sale` |
**Response:**
```json
{
"categories": 5,
"products": 120
}
```
---
### Settings
#### Get Settings
```http
GET /wp-json/productbay/v1/settings
```
Returns current plugin settings merged with defaults.
---
#### Update Settings
```http
POST /wp-json/productbay/v1/settings
```
Updates plugin settings.
| Body Parameter | Type | Description |
|---------------|------|-------------|
| `settings` | object | Settings key-value pairs to update |
---
#### Reset All Data
```http
POST /wp-json/productbay/v1/settings/reset
```
> **Danger: Destructive Action**
> This endpoint deletes **all tables**, clears all metadata, and resets settings to defaults. This cannot be undone.
**Response:**
```json
{
"success": true,
"deleted_tables": 5,
"settings": { ... }
}
```
---
### System
#### System Status
```http
GET /wp-json/productbay/v1/system/status
```
Returns system information (table counts, WooCommerce status, etc.).
---
#### Mark Onboarded
```http
POST /wp-json/productbay/v1/system/onboard
```
Marks the onboarding process as completed.
---
### Preview
#### Generate Preview
```http
POST /wp-json/productbay/v1/preview
```
Renders a table preview from the provided configuration. Used by the Creation Wizard's live preview feature.
---
### Logs
#### Get Activity Logs
```http
GET /wp-json/productbay/v1/logs
```
Returns paginated activity log entries.
| Parameter | Type | Description |
|-----------|------|-------------|
| `limit` | integer | Results per page (default: 50) |
| `page` | integer | Page number (default: 1) |
---
#### Export Logs
```http
GET /wp-json/productbay/v1/logs/export
```
Downloads all activity logs as a CSV file.
---
#### Clear Logs
```http
POST /wp-json/productbay/v1/logs/clear
```
Permanently deletes all activity log entries. This action cannot be undone.
---
## Hooks & Filters
> Source: https://docs.wpanchorbay.com/productbay/developer/hooks
# Hooks & Filters
ProductBay provides an extensive set of WordPress action hooks and filters, enabling developers to extend, customize, and integrate with the plugin without modifying its core source files.
> **Info: Since v1.0.0**
> All hooks listed on this page were introduced in ProductBay **1.0.0**.
## Hook Naming Convention
All hooks are prefixed with `productbay_` to avoid collisions:
- **Actions** — Use `do_action( 'productbay_*' )`
- **Filters** — Use `apply_filters( 'productbay_*' )`
---|--------|
| **Parameters** | `$plugin` *(Plugin)* — The main plugin instance |
| **File** | `app/Core/Plugin.php` |
```php
add_action( 'productbay_loaded', function( $plugin ) {
// Your add-on logic here
} );
```
### `productbay_admin_init`
Fires after the admin component is set up (inside `is_admin()` context only).
| Type | Action |
|------|--------|
| **Parameters** | `$admin` *(Admin)* — The admin instance |
| **File** | `app/Core/Plugin.php` |
---
## Data Layer
Hooks around table CRUD operations in `TableRepository`.
### `productbay_before_save_table`
Filters table data before it is persisted.
| Type | Filter |
|------|--------|
| **Parameters** | `$data` *(array)*, `$id` *(int)* |
| **Returns** | `array` — Modified table data |
| **File** | `app/Data/TableRepository.php` |
```php
add_filter( 'productbay_before_save_table', function( $data, $id ) {
// Validate or modify data before save
return $data;
}, 10, 2 );
```
### `productbay_after_save_table`
Fires after a table is successfully saved.
| Type | Action |
|------|--------|
| **Parameters** | `$post_id` *(int)*, `$data` *(array)* |
| **File** | `app/Data/TableRepository.php` |
### `productbay_after_delete_table`
Fires after a table is deleted.
| Type | Action |
|------|--------|
| **Parameters** | `$id` *(int)* — The deleted post ID |
| **File** | `app/Data/TableRepository.php` |
### `productbay_table_data`
Filters the formatted table data returned by the repository.
| Type | Filter |
|------|--------|
| **Parameters** | `$table_data` *(array)*, `$post` *(WP_Post)* |
| **Returns** | `array` — Modified table data |
| **File** | `app/Data/TableRepository.php` |
```php
add_filter( 'productbay_table_data', function( $data, $post ) {
$data['my_pro_field'] = get_post_meta( $post->ID, '_my_pro_meta', true );
return $data;
}, 10, 2 );
```
---
## API Layer
Hooks for extending the REST API and settings.
### `productbay_register_routes`
Fires after all core REST routes are registered. Use this to register additional endpoints.
| Type | Action |
|------|--------|
| **Parameters** | `$router` *(Router)* — The router instance |
| **File** | `app/Http/Router.php` |
```php
add_action( 'productbay_register_routes', function( $router ) {
register_rest_route( 'productbay/v1', '/my-endpoint', [ /* ... */ ] );
} );
```
### `productbay_default_settings`
Filters the default plugin settings array.
| Type | Filter |
|------|--------|
| **Parameters** | `$defaults` *(array)* |
| **Returns** | `array` — Modified defaults |
| **File** | `app/Api/SettingsController.php` |
### `productbay_get_settings`
Filters settings before they are returned to the frontend.
| Type | Filter |
|------|--------|
| **Parameters** | `$settings` *(array)* |
| **Returns** | `array` — Modified settings |
| **File** | `app/Api/SettingsController.php` |
### `productbay_settings_updated`
Fires after settings are saved.
| Type | Action |
|------|--------|
| **Parameters** | `$settings` *(array)* — The saved settings |
| **File** | `app/Api/SettingsController.php` |
### `productbay_system_status`
Filters the system status data (used by the Dashboard).
| Type | Filter |
|------|--------|
| **Parameters** | `$status` *(array)* |
| **Returns** | `array` — Modified status data |
| **File** | `app/Api/SystemController.php` |
```php
add_filter( 'productbay_system_status', function( $status ) {
$status['pro_license'] = 'active';
return $status;
} );
```
---
## Frontend Rendering
The most critical layer for extending table output. All hooks are in `TableRenderer.php` unless noted otherwise.
### `productbay_query_args`
Filters `WP_Query` arguments before the product query executes.
| Type | Filter |
|------|--------|
| **Parameters** | `$args` *(array)*, `$source` *(array)*, `$settings` *(array)* |
| **Returns** | `array` — Modified query args |
| **File** | `app/Frontend/TableRenderer.php` |
```php
add_filter( 'productbay_query_args', function( $args, $source, $settings ) {
// Example: only show featured products
$args['tax_query'][] = [
'taxonomy' => 'product_visibility',
'field' => 'name',
'terms' => 'featured',
];
return $args;
}, 10, 3 );
```
### `productbay_table_columns`
Filters the columns array before rendering.
| Type | Filter |
|------|--------|
| **Parameters** | `$columns` *(array)*, `$table_id` *(int)* |
| **Returns** | `array` — Modified columns |
### `productbay_cell_output`
Filters a single cell's HTML output.
| Type | Filter |
|------|--------|
| **Parameters** | `$cell_html` *(string)*, `$col` *(array)*, `$product` *(WC_Product)* |
| **Returns** | `string` — Modified HTML |
```php
add_filter( 'productbay_cell_output', function( $html, $col, $product ) {
if ( $col['type'] === 'my_custom_type' ) {
return '' . esc_html( $product->get_attribute('brand') ) . '';
}
return $html;
}, 10, 3 );
```
### `productbay_table_output`
Filters the complete table HTML before it is returned.
| Type | Filter |
|------|--------|
| **Parameters** | `$html` *(string)*, `$table` *(array)* |
| **Returns** | `string` — Modified HTML |
### `productbay_table_styles`
Filters the generated scoped CSS for a table.
| Type | Filter |
|------|--------|
| **Parameters** | `$css` *(string)*, `$table` *(array)* |
| **Returns** | `string` — Modified CSS |
### `productbay_before_table` / `productbay_after_table`
Actions fired before and after the table wrapper ``.
| Type | Action |
|------|--------|
| **Parameters** | `$table` *(array)* |
### `productbay_before_row` / `productbay_after_row`
Actions fired before and after each product row `
`.
| Type | Action |
|------|--------|
| **Parameters** | `$product` *(WC_Product)*, `$table` *(array)* |
### `productbay_toolbar_start` / `productbay_toolbar_end`
Actions to inject content at the start or end of the toolbar area (above the table, where search and bulk actions live).
| Type | Action |
|------|--------|
| **Parameters** | `$table` *(array)* |
---
## Frontend AJAX
Hooks for AJAX operations in `AjaxRenderer.php`.
### `productbay_ajax_filter_response`
Filters the AJAX response for table filtering/search/pagination.
| Type | Filter |
|------|--------|
| **Parameters** | `$response` *(array)*, `$table` *(array)* |
| **Returns** | `array` — Modified response |
### `productbay_after_bulk_add_to_cart`
Fires after a bulk add-to-cart operation completes.
| Type | Action |
|------|--------|
| **Parameters** | `$added_count` *(int)*, `$errors` *(array)* |
---
## Shortcode
Hooks in `Shortcode.php`.
### `productbay_shortcode_atts`
Filters the parsed shortcode attributes.
| Type | Filter |
|------|--------|
| **Parameters** | `$atts` *(array)* |
| **Returns** | `array` — Modified attributes |
### `productbay_enqueue_frontend_assets`
Action to enqueue additional frontend assets when a ProductBay shortcode is rendered.
| Type | Action |
|------|--------|
| **Parameters** | *(none)* |
---
## Admin
Hooks in `Admin.php`.
### `productbay_after_register_menu`
Fires after all admin menu items are registered.
| Type | Action |
|------|--------|
| **Parameters** | *(none)* |
### `productbay_admin_script_data`
Filters the data passed to the React admin app via `wp_localize_script`.
| Type | Filter |
|------|--------|
| **Parameters** | `$data` *(array)* |
| **Returns** | `array` — Modified script data |
```php
add_filter( 'productbay_admin_script_data', function( $data ) {
$data['proActive'] = true;
$data['license'] = 'valid';
return $data;
} );
```
### `productbay_enqueue_admin_assets`
Action to enqueue additional admin assets on ProductBay pages.
| Type | Action |
|------|--------|
| **Parameters** | *(none)* |
---
## Contributing
> Source: https://docs.wpanchorbay.com/productbay/developer/contributing
# Contributing
Thank you for your interest in contributing to ProductBay! This guide will help you set up a local development environment.
## Prerequisites
| Tool | Version | Purpose |
|------|---------|---------|
| **Node.js** | 18+ | JavaScript runtime |
| **Bun** | Latest | Package manager & script runner |
| **Composer** | 2+ | PHP dependency manager |
| **PHP** | 7.4+ (8.0+ recommended) | Backend language |
| **WordPress** | 6.0+ | CMS platform |
| **WooCommerce** | 6.1+ | E-commerce dependency |
You'll also need a local WordPress development environment such as XAMPP, LAMP, LocalWP, or similar.
## Setup
### 1. Clone the Repository
```bash
cd wp-content/plugins
git clone https://github.com/wpanchorbay/productbay.git
cd productbay
```
### 2. Install Dependencies
Install JavaScript dependencies:
```bash
bun install
```
Install PHP dependencies:
```bash
composer install
```
### 3. Configure Environment
Copy the example environment file:
```bash
cp .env.example .env
```
Edit `.env` and set the appropriate values for your local setup.
### 4. Start Development
```bash
bun start
```
This runs both Webpack (for JS/TS compilation) and Tailwind CLI (for CSS) in parallel watch mode. Changes hot-reload automatically.
### 5. Build for Production
```bash
bun run build
```
This creates optimized, minified assets in the `assets/` directory.
## Project Structure
```
productbay/
├── app/ # PHP backend (Admin, Api, Core, Data, Frontend, Http)
├── src/ # React/TypeScript frontend source
├── assets/ # Compiled JS/CSS output
├── languages/ # Translation files
├── scripts/ # Build helper scripts
├── docs/ # This documentation site (VitePress)
├── vendor/ # Composer dependencies
└── node_modules/ # JavaScript dependencies
```
## Coding Standards
### PHP
- Follow [WordPress PHP Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/)
- Run PHPCS: `./vendor/bin/phpcs`
- Use `snake_case` for functions/variables, `PascalCase` for classes
- Add PHPDoc blocks to all classes and methods
- Sanitize all inputs, escape all outputs
### JavaScript / TypeScript
- TypeScript strict mode (ES2020)
- Use `@wordpress/i18n` for translatable strings
- Path alias: `@/*` → `src/*`
- Use CVA + clsx + tailwind-merge for dynamic class names
### CSS
- Tailwind CSS v4 with utility-first approach
- All styles scoped to `#productbay-root`
- Frontend table classes prefixed with `productbay-`
## Internationalization (i18n)
All user-facing strings must be translatable:
**PHP:**
```php
__( 'Text', 'productbay' ) // Return translated string
_e( 'Text', 'productbay' ) // Echo translated string
```
**React/TypeScript:**
```typescript
import { __ } from '@wordpress/i18n';
const label = __( 'Text', 'productbay' );
```
Generate translation files:
```bash
bun run i18n:make-pot # Extract strings to .pot
bun run i18n:make-json # Convert .po to .json for React
```
## Reporting Issues
Found a bug or have a suggestion? Please open an issue on the [GitHub Issue Tracker](https://github.com/wpanchorbay/productbay/issues).
When reporting, include:
1. A clear description of the problem
2. Steps to reproduce
3. Screenshots or error logs (if applicable)
4. Your WordPress, WooCommerce, and PHP versions
## Contact Developers
ProductBay is developed by [WPAnchorBay](https://wpanchorbay.com). If you need help or have questions, please [contact us](https://wpanchorbay.com/contact-us/) or directly email us at [support@wpanchorbay.com](mailto:[support@wpanchorbay.com]). If you need urgent help, reach out to the lead developer [Forhad Khan](https://forhadkhan.com).
---
============================================================
SECTION: SUPPORT
============================================================
## FAQ
> Source: https://docs.wpanchorbay.com/productbay/faq
# Frequently Asked Questions
## General
### Does this plugin require WooCommerce?
Yes. ProductBay is a WooCommerce extension and **will not function** without WooCommerce installed and active. The plugin checks for WooCommerce on activation and will display a notice if it's missing.
### Which WordPress versions are supported?
ProductBay requires **WordPress 6.0 or later**. We recommend always running the latest stable version of WordPress.
### Which PHP versions are supported?
ProductBay requires **PHP 7.4 or later**. We recommend **PHP 8.0+** for the best performance and compatibility.
## ProductBay Pro [Pro]
### Is there a Pro version?
Yes! **ProductBay Pro** is now available. It adds advanced features like a Price Range Filter, advanced display modes for Variable and Grouped products (Popup Modals, Nested Rows), a powerful Custom Field column, and Import/Export capabilities.
### What does ProductBay Pro include?
You can see a full feature comparison between the Free and Pro versions on our [homepage](/).
## License & Updates
### Do I need a license key to use ProductBay?
No. The core version of ProductBay is 100% free forever. A license key is only needed if you purchase ProductBay Pro to access premium features.
### How do I activate my Pro license key?
After purchasing, you can enter your license key under **ProductBay → Settings → License**. For step-by-step instructions, see our [License Activation](/features/license) guide.
### Can I use Pro on multiple sites?
This depends on the license plan you purchased. Single-site licenses allow activation on one production domain, while Plus and Agency licenses allow activation on multiple sites. Check your WPAnchorBay account for details.
### How do I update ProductBay Pro?
As long as your license is active, ProductBay Pro receives automatic updates directly through your WordPress Plugins dashboard, just like the free version.
## Product Tables
### How do I display a table on a page?
After creating a table in the ProductBay admin, copy its shortcode (e.g., `[productbay id="1"]`) and paste it into any page, post, or widget using the Shortcode block. See the [Shortcodes guide](/features/shortcodes) for details.
### Can I display multiple tables on the same page?
Yes! Each table has its own **scoped CSS**, so multiple tables on the same page will not conflict with each other's styling. Simply add multiple shortcodes:
```
[productbay id="1"]
[productbay id="2"]
```
### Which product types are supported?
ProductBay supports all standard WooCommerce product types:
- ✅ **Simple** products
- ✅ **Variable** products (with inline attribute selectors)
- ✅ **Grouped** products
- ✅ **External / Affiliate** products
### Can customers select product variations in the table?
Yes! Variable products display inline dropdown selectors for each attribute (size, color, etc.) directly within the table row. Customers can choose variations and add to cart without visiting the product page.
## Performance & Privacy
### Will it slow down my site?
ProductBay is built with performance in mind:
- Assets are loaded **only on pages** where a table shortcode is present
- Product queries are **cached for 30 minutes** to minimize database load
- The frontend uses lightweight PHP rendering, not a heavy JavaScript framework
### Does this plugin call any external services?
**No.** All JavaScript, CSS, and other assets are bundled locally within the plugin. No data is sent to, or loaded from, any external server.
> **Info: Note for Pro Users**
> ProductBay Pro contacts the WPAnchorBay license server solely for license activation and validation. No user data or product data is transmitted.
## Translation & Localization
### Is it translation ready?
Yes. 100% of user-facing strings use WordPress localization functions (`__()`, `_e()`, `@wordpress/i18n`). The plugin is fully prepared for translation into any language.
### How do I translate the plugin?
1. Use a translation plugin like **Loco Translate** or **WPML**
2. Or create a `.po` file for your language based on the included `languages/productbay.pot` file
3. Place the translation files in `wp-content/languages/plugins/`
## Troubleshooting
### My table is not showing on the page
Check the following:
1. **Table status** — Make sure the table is set to "Published" (Private tables won't display)
2. **Correct shortcode** — Verify the table ID in the shortcode matches your table
3. **WooCommerce active** — Ensure WooCommerce is installed and active
4. **Products exist** — Make sure the product source has matching published products
### I see a yellow notice instead of my table
This means the table is set to **Private**. Only administrators see this notice — regular visitors see nothing. To fix it, edit the table and change its status to **Published**.
### The table looks broken or unstyled
- Clear your browser cache and any WordPress caching plugins
- Check for CSS conflicts with your theme — ProductBay uses scoped CSS, but aggressive theme styles could interfere
- Make sure you're running a supported WordPress version
## Support
### Where can I get help?
- Use the support forum on the [WordPress.org plugin page](https://wordpress.org/support/plugin/productbay/)
- Report bugs via the [GitHub Issue Tracker](https://github.com/wpanchorbay/productbay/issues)
- We aim to respond within 2 business days
---
## Known Issues
> Source: https://docs.wpanchorbay.com/productbay/known-issues
# Known Issues
This page tracks known issues and active limitations in ProductBay Free and Pro versions, along with available workarounds and fixes or expected resolution plans.
**Any known issues will be listed here**
---
## Report a New Issue
Did you encounter a bug that isn't listed here?
Please help us improve ProductBay by [opening a detailed issue on GitHub](https://github.com/wpanchorbay/productbay/issues)! You can also reach out to our active developer channels for faster triage. Feel free to reach out to us at [contact@wpanchorbay.com](mailto:contact@wpanchorbay.com) for any issues or concerns.
---
============================================================
SECTION: RELEASE HISTORY
============================================================
## Changelog
> Source: https://docs.wpanchorbay.com/productbay/changelog
# Changelog
All notable changes to ProductBay are documented on this page.
Looking for Pro version changes? See the **[Pro Changelog](./pro-changelog.md)**.
## 1.3.0
* **Feature:** Introduced native **Permalink Pages** for product tables via `productbay_table` Custom Post Type.
* **Feature:** Grouped products now default to **Inline Dropdown** mode for direct child product selection and add-to-cart.
* **Feature:** Introduced a comprehensive, file-based **Activity Log** system to track table management and system events.
* **Feature:** Decoupled cart functionality from AJAX to support native form submissions and improved compatibility.
* **Dev:** Optimized internal code architecture and registered `productbay_table` CPT with frontend support.
## 1.2.0
* **Feature:** Added new column types: Stock, Date, Taxonomy, and Rating.
* **Feature:** Introduced Pro integration for premium features: Custom Field, Combined, Price Range Filter, and Variable & Grouped Products.
* **Dev:** Unified Pro activation detection across Free plugin layers.
## 1.1.1
* **Improvement:** Block setup experience with "Create New Table" link in placeholders.
* **Improvement:** Removed misleading product counts from category multiselect filters.
* **Improvement:** Enhanced reliability of CSS injection into the Block Editor iframe.
* **Fix:** Isolated table event handlers to prevent cross-tab state interference (e.g. AJAX filter state).
## 1.1.0
* **Feature:** Native Gutenberg blocks for Product Table and Tabbed Product Tables with server-side rendering.
* **Improvement:** Filters bar repositioned above toolbar for better UX flow.
* **Improvement:** Admin menu (WooCommerce > Products) renamed from "All Tables" to "Product Tables" for clarity.
* **Improvement:** Added a "Manage" link to the plugin action links on the Plugins page for quicker access.
* **Improvement:** Hover highlight improvements across admin UI.
* **Improvement:** Shortcode display layout refined on the table management page.
* **Dev:** Restructured codebase for Pro extension architecture.
* **Dev:** Exposed UI components and settings globally for Pro add-on consumption.
## 1.0.0
*Initial Release*
---
## Pro Changelog
> Source: https://docs.wpanchorbay.com/productbay/pro-changelog
# Pro Changelog
All notable changes to ProductBay Pro are documented on this page.
Looking for core changes? See the [Core Changelog](./changelog.md).
## 1.0.0
* Initial release of ProductBay Pro.
* **Feature:** Price Range Filter with slider, inputs, or combined mode.
* **Feature:** Variable & Grouped Product display modes: Inline, Popup Modal, Nested Rows, Separate Rows.
* **Feature:** Custom Field Column with meta-key discovery, ACF integration.
* **Feature:** Combined Column using template tags.
* **Feature:** Import / Export for table configurations via JSON.
* **Feature:** License activation, validation, and auto-updates mechanism.
---