Compare commits

..
5 Commits
Author SHA1 Message Date
magdevandClaude Opus 4.6 ed66c96d3d Consolidate documentation, bump to v1.2.1
Create Release Package / build-release (push) Successful in 56s
Condense CLAUDE.md from ~1960 to ~160 lines keeping only essential
architecture and lessons learned. Merge INSTALL.md into README.md
and IMPLEMENTATION.md into CLAUDE.md, then delete the source files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-01 12:14:07 +01:00
magdevandClaude Opus 4.6 ea64dbfb33 Update .gitignore: add logs/ dir and compiled .mo files
CI/CD workflow now compiles .mo files during release, so they
no longer need to be tracked in git.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-01 12:04:34 +01:00
magdevandClaude Opus 4.6 6507f4d8bb v1.2.0 - Fix product selection, cart pricing, admin tabs + CI/CD
Fix three critical bugs that persisted through v1.1.11-v1.1.14:

- Product selection always empty: meta_query checked _product_type in
  postmeta, but WooCommerce uses the product_type taxonomy. Replaced
  with correct tax_query using NOT IN operator.
- Cart price always 0.00: composable_price_calculated flag persisted
  in session, preventing recalculation on page loads. Removed flag;
  static variable already handles per-request dedup.
- Admin tabs both visible on load: JS now triggers WooCommerce native
  tab click instead of manually toggling panel visibility.

Add Gitea CI/CD release workflow triggered on v* tags.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-01 12:01:20 +01:00
magdevandClaude Sonnet 4.5 29a68b0be4 Add session learnings and context notes to v1.1.14 history
Key learnings documented:
- Diagnostic-first approach after multiple failed fixes
- User has no live access currently (testing delayed)
- Release workflow now well-established
- Shell context handling with absolute paths
- Debug logging best practices
- Context preservation from session summary

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-01 02:29:46 +01:00
magdevandClaude Sonnet 4.5 fb8ddf903e Document v1.1.14 debug logging release in session history
Added comprehensive session notes for v1.1.14 including:
- Debug logging implementation strategy
- All 7 logging points in product retrieval
- How to use the debug release
- Expected log output and interpretation
- Next steps after receiving user logs

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-01 02:28:45 +01:00
70 changed files with 493 additions and 2335 deletions

No files matched your search

+205
View File
@@ -0,0 +1,205 @@
name: Create Release Package
on:
push:
tags:
- 'v*'
jobs:
build-release:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
extensions: mbstring, xml, zip, intl, gettext
tools: composer:v2
- name: Get version from tag
id: version
run: |
VERSION=${GITHUB_REF_NAME#v}
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "Building version: $VERSION"
- name: Validate composer.json
run: composer validate --strict
- name: Install Composer dependencies (production)
run: |
composer config platform.php 8.3.0
composer install --no-dev --optimize-autoloader --no-interaction
- name: Install gettext
run: apt-get update && apt-get install -y gettext
- name: Compile translations
run: |
for po in languages/*.po; do
if [ -f "$po" ]; then
mo="${po%.po}.mo"
echo "Compiling $po to $mo"
msgfmt -o "$mo" "$po"
fi
done
- name: Verify plugin version matches tag
run: |
PLUGIN_VERSION=$(grep -oP "Version:\s*\K[0-9]+\.[0-9]+\.[0-9]+" wc-composable-product.php | head -1)
TAG_VERSION=${{ steps.version.outputs.version }}
if [ "$PLUGIN_VERSION" != "$TAG_VERSION" ]; then
echo "Error: Plugin version ($PLUGIN_VERSION) does not match tag version ($TAG_VERSION)"
exit 1
fi
echo "Version verified: $PLUGIN_VERSION"
- name: Create release directory
run: mkdir -p releases
- name: Build release package
run: |
VERSION=${{ steps.version.outputs.version }}
PLUGIN_NAME="wc-composable-product"
RELEASE_FILE="releases/${PLUGIN_NAME}-${VERSION}.zip"
# Move to parent directory for proper zip structure
cd ..
# Create zip with proper WordPress plugin structure
zip -r "${PLUGIN_NAME}/${RELEASE_FILE}" "${PLUGIN_NAME}" \
-x "${PLUGIN_NAME}/.git/*" \
-x "${PLUGIN_NAME}/.gitea/*" \
-x "${PLUGIN_NAME}/.github/*" \
-x "${PLUGIN_NAME}/.vscode/*" \
-x "${PLUGIN_NAME}/.claude/*" \
-x "${PLUGIN_NAME}/CLAUDE.md" \
-x "${PLUGIN_NAME}/wp-core" \
-x "${PLUGIN_NAME}/wp-core/*" \
-x "${PLUGIN_NAME}/wp-plugins" \
-x "${PLUGIN_NAME}/wp-plugins/*" \
-x "${PLUGIN_NAME}/releases/*" \
-x "${PLUGIN_NAME}/cache/*" \
-x "${PLUGIN_NAME}/composer.lock" \
-x "${PLUGIN_NAME}/*.log" \
-x "${PLUGIN_NAME}/.gitignore" \
-x "${PLUGIN_NAME}/.editorconfig" \
-x "${PLUGIN_NAME}/phpcs.xml*" \
-x "${PLUGIN_NAME}/phpunit.xml*" \
-x "${PLUGIN_NAME}/tests/*" \
-x "${PLUGIN_NAME}/*.po~" \
-x "${PLUGIN_NAME}/*.bak" \
-x "*.DS_Store"
cd "${PLUGIN_NAME}"
echo "Created: ${RELEASE_FILE}"
- name: Generate checksums
run: |
VERSION=${{ steps.version.outputs.version }}
cd releases
sha256sum "wc-composable-product-${VERSION}.zip" > "wc-composable-product-${VERSION}.zip.sha256"
echo "SHA256:"
cat "wc-composable-product-${VERSION}.zip.sha256"
- name: Verify package structure
run: |
set +o pipefail
VERSION=${{ steps.version.outputs.version }}
echo "Package contents:"
unzip -l "releases/wc-composable-product-${VERSION}.zip" | head -50 || true
# Verify main file is at correct location
if unzip -l "releases/wc-composable-product-${VERSION}.zip" | grep -q "wc-composable-product/wc-composable-product.php"; then
echo "✓ Main plugin file at correct location"
else
echo "✗ Error: Main plugin file not found at wc-composable-product/wc-composable-product.php"
exit 1
fi
# Verify vendor directory is included
if unzip -l "releases/wc-composable-product-${VERSION}.zip" | grep -q "wc-composable-product/vendor/"; then
echo "✓ Vendor directory included"
else
echo "✗ Error: Vendor directory not found"
exit 1
fi
- name: Extract changelog for release notes
id: changelog
run: |
VERSION=${{ steps.version.outputs.version }}
# Extract changelog section for this version
NOTES=$(sed -n "/^## \[${VERSION}\]/,/^## \[/p" CHANGELOG.md | sed '$ d' | tail -n +2)
if [ -z "$NOTES" ]; then
NOTES="Release version ${VERSION}"
fi
# Save to file for multi-line output
echo "$NOTES" > release_notes.txt
echo "Release notes extracted"
- name: Create Gitea Release
env:
GITEA_TOKEN: ${{ secrets.SRC_GITEA_TOKEN }}
run: |
VERSION=${{ steps.version.outputs.version }}
TAG_NAME=${{ github.ref_name }}
PRERELEASE="false"
if [[ "$TAG_NAME" == *-* ]]; then
PRERELEASE="true"
fi
# Read release notes
BODY=$(cat release_notes.txt)
# Check if release already exists for this tag and delete it
EXISTING_RELEASE=$(curl -s \
-H "Authorization: token ${GITEA_TOKEN}" \
"${GITHUB_SERVER_URL}/api/v1/repos/${GITHUB_REPOSITORY}/releases/tags/${TAG_NAME}")
EXISTING_ID=$(echo "$EXISTING_RELEASE" | jq -r '.id // empty')
if [ -n "$EXISTING_ID" ] && [ "$EXISTING_ID" != "null" ]; then
echo "Deleting existing release ID: $EXISTING_ID"
curl -s -X DELETE \
-H "Authorization: token ${GITEA_TOKEN}" \
"${GITHUB_SERVER_URL}/api/v1/repos/${GITHUB_REPOSITORY}/releases/${EXISTING_ID}"
fi
# Create release via Gitea API
RELEASE_RESPONSE=$(curl -s -X POST \
-H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/json" \
-d "{\"tag_name\": \"${TAG_NAME}\", \"name\": \"Release ${VERSION}\", \"body\": $(echo "$BODY" | jq -Rs .), \"draft\": false, \"prerelease\": ${PRERELEASE}}" \
"${GITHUB_SERVER_URL}/api/v1/repos/${GITHUB_REPOSITORY}/releases")
RELEASE_ID=$(echo "$RELEASE_RESPONSE" | jq -r '.id')
if [ "$RELEASE_ID" == "null" ] || [ -z "$RELEASE_ID" ]; then
echo "Failed to create release:"
echo "$RELEASE_RESPONSE"
exit 1
fi
echo "Created release ID: $RELEASE_ID"
# Upload attachments
for file in "releases/wc-composable-product-${VERSION}.zip" "releases/wc-composable-product-${VERSION}.zip.sha256"; do
if [ -f "$file" ]; then
FILENAME=$(basename "$file")
echo "Uploading $FILENAME..."
curl -s -X POST \
-H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/octet-stream" \
--data-binary "@$file" \
"${GITHUB_SERVER_URL}/api/v1/repos/${GITHUB_REPOSITORY}/releases/${RELEASE_ID}/assets?name=${FILENAME}"
echo "Uploaded $FILENAME"
fi
done
echo "Release created successfully: ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/releases/tag/${TAG_NAME}"
Regular → Executable
+5 -6
View File
@@ -1,14 +1,8 @@
# Linked sources
wp-core
wp-plugins
tpp
# Editor swap files # Editor swap files
*.*swp *.*swp
# Composer # Composer
vendor/ vendor/
composer.lock
# Cache # Cache
cache/ cache/
@@ -16,9 +10,14 @@ cache/
# Development files # Development files
.vscode/ .vscode/
.idea/ .idea/
logs/
*.log *.log
# OS files # OS files
.DS_Store .DS_Store
Thumbs.db Thumbs.db
.directory
# Binary files
languages/*.mo
+53
View File
@@ -5,6 +5,59 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.2.1] - 2026-03-01
### Changed
- Consolidated documentation: merged INSTALL.md into README.md, merged IMPLEMENTATION.md into CLAUDE.md
- Condensed CLAUDE.md from ~1960 lines to ~160 lines, keeping only essential architecture and lessons learned
- README.md now includes full installation guide, usage tutorial, and troubleshooting section
- Cleaned up .gitignore
### Removed
- INSTALL.md (content merged into README.md)
- IMPLEMENTATION.md (content merged into CLAUDE.md)
## [1.2.0] - 2026-03-01
### Fixed
- **CRITICAL**: Product selection always empty regardless of configuration (categories, tags, or SKUs)
- Root cause: Product query used a `meta_query` checking `_product_type` in `wp_postmeta`, but WooCommerce stores product types in the `product_type` **taxonomy** — the `!=` comparison with a non-existent meta key caused an INNER JOIN returning zero results
- Fix: Replaced broken `meta_query` with correct `tax_query` using `product_type` taxonomy to exclude composable products
- **CRITICAL**: Cart price always 0.00 despite correct frontend price calculation
- Root cause: `composable_price_calculated` flag was persisted to the cart session, preventing price recalculation on subsequent page loads — but `set_price()` only modifies the in-memory product object and is lost between requests
- Fix: Removed per-item session flag; the existing static `$already_calculated` flag already prevents duplicate calculation within a single request
- **Admin tab rendering**: Both General and Composable Options panels visible on initial page load
- Root cause: JavaScript manually showed `#composable_product_data` via `.show()` without hiding the General panel
- Fix: Trigger WooCommerce's native tab click instead, so the tab system handles panel visibility correctly
### Added
- **Gitea CI/CD release workflow** (`.gitea/workflows/release.yml`)
- Triggered on `v*` tags
- Installs PHP 8.3 with production Composer dependencies
- Compiles `.po` → `.mo` translations
- Verifies plugin version matches tag
- Builds release ZIP with proper WordPress directory structure
- Generates SHA-256 checksums
- Verifies package contains main plugin file and vendor directory
- Extracts changelog for release notes
- Creates Gitea release with attachments via API
### Removed
- Debug logging from v1.1.14 (no longer needed after root cause identified)
### Technical
- Modified files: includes/Product_Type.php, includes/Cart_Handler.php, assets/js/admin.js
- New file: .gitea/workflows/release.yml
- Product query now correctly uses `tax_query` with `product_type` taxonomy (`NOT IN` operator)
- Cart price recalculated on every request via `woocommerce_before_calculate_totals` hook
- Admin JS uses `$('ul.product_data_tabs li.composable_options a').trigger('click')` for native WooCommerce tab handling
## [1.1.14] - 2025-12-31 ## [1.1.14] - 2025-12-31
### Added ### Added
+102 -1640
View File
File diff suppressed because it is too large. Load diff
-434
View File
@@ -1,434 +0,0 @@
# WooCommerce Composable Products - Implementation Summary
## Overview
This document provides a technical overview of the WooCommerce Composable Products plugin implementation.
**Version:** 1.0.0
**Created:** 2024-12-31
**AI-Generated:** 100% created with Claude.AI assistance
## Architecture
### Plugin Structure
```txt
wc-composable-product/
├── assets/ # Frontend assets
│ ├── css/
│ │ ├── admin.css # Admin styles
│ │ └── frontend.css # Frontend styles
│ └── js/
│ ├── admin.js # Admin JavaScript
│ └── frontend.js # Frontend JavaScript
├── cache/ # Twig template cache
├── includes/ # PHP classes
│ ├── Admin/
│ │ ├── Product_Data.php # Product data tab
│ │ └── Settings.php # Settings page
│ ├── Cart_Handler.php # Cart integration
│ ├── Plugin.php # Main plugin class
│ ├── Product_Selector.php # Frontend selector
│ └── Product_Type.php # Custom product type
├── languages/ # Translation files
│ └── wc-composable-product.pot
├── templates/ # Twig templates
│ └── product-selector.twig
└── wc-composable-product.php # Main plugin file
```
## Core Components
### 1. Main Plugin Class (`Plugin.php`)
**Responsibilities:**
- Singleton pattern implementation
- Twig template engine initialization
- Hook registration
- Component initialization
- Asset enqueuing
**Key Methods:**
- `instance()`: Get singleton instance
- `init_twig()`: Initialize Twig with WordPress functions
- `render_template()`: Render Twig templates
- `add_product_type()`: Register composable product type
### 2. Product Type (`Product_Type.php`)
**Extends:** `WC_Product`
**Key Features:**
- Custom product type: `composable`
- Selection limit management (per-product or global)
- Pricing mode (fixed or sum)
- Product selection criteria (category/tag/SKU)
- Dynamic product availability
- Price calculation
**Key Methods:**
- `get_selection_limit()`: Get max selectable items
- `get_pricing_mode()`: Get pricing calculation mode
- `get_available_products()`: Query available products
- `calculate_composed_price()`: Calculate final price
### 3. Admin Settings (`Admin/Settings.php`)
**Extends:** `WC_Settings_Page`
**Global Settings:**
- Default selection limit
- Default pricing mode
- Display options (images, prices, total)
**Integration:** Adds tab to WooCommerce Settings
### 4. Product Data Tab (`Admin/Product_Data.php`)
**Responsibilities:**
- Add "Composable Options" tab to product edit page
- Render selection criteria fields
- Save product meta data
- Dynamic field visibility based on criteria type
**Saved Meta:**
- `_composable_selection_limit`: Item limit
- `_composable_pricing_mode`: Pricing calculation
- `_composable_criteria_type`: Selection method
- `_composable_categories`: Selected categories
- `_composable_tags`: Selected tags
- `_composable_skus`: SKU list
### 5. Product Selector (`Product_Selector.php`)
**Responsibilities:**
- Render frontend product selection interface
- Prepare data for Twig template
- Apply display settings
**Template Variables:**
- `products`: Available products array
- `selection_limit`: Max selections
- `pricing_mode`: Pricing calculation
- `show_images/prices/total`: Display flags
### 6. Cart Handler (`Cart_Handler.php`)
**Responsibilities:**
- Validate product selection
- Add selected products to cart data
- Calculate dynamic pricing
- Display selected products in cart
**Hooks:**
- `woocommerce_add_to_cart_validation`: Validate selections
- `woocommerce_add_cart_item_data`: Store selections
- `woocommerce_before_calculate_totals`: Update prices
- `woocommerce_get_item_data`: Display in cart
## Frontend Implementation
### Product Selector Template (`product-selector.twig`)
**Features:**
- Responsive grid layout
- Checkbox-based selection
- Product images and prices
- Real-time total calculation
- AJAX add-to-cart
**Data Attributes:**
- `data-product-id`: Composable product ID
- `data-selection-limit`: Max selections
- `data-pricing-mode`: Pricing mode
- `data-price`: Individual product prices
### JavaScript (`frontend.js`)
**Functionality:**
- Selection limit enforcement
- Visual feedback on selection
- Real-time price updates (sum mode)
- AJAX cart operations
- Error/success messages
**Key Functions:**
- `handleCheckboxChange()`: Selection logic
- `updateTotalPrice()`: Calculate total
- `addToCart()`: AJAX add-to-cart
- `showMessage()`: User feedback
### CSS Styling
**Approach:**
- Grid-based layout (responsive)
- Card-style product items
- Visual selection states
- Mobile-first design
- Breakpoints: 768px, 480px
## Data Flow
### Creating a Composable Product
1. Admin selects "Composable product" type
2. Configure selection limit and pricing mode
3. Choose selection criteria (category/tag/SKU)
4. Save product metadata
5. WooCommerce registers product with custom type
### Frontend Display
1. Customer visits product page
2. `Cart_Handler` renders `Product_Selector`
3. `Product_Type::get_available_products()` queries products
4. Twig template renders grid with products
5. JavaScript handles interactions
### Adding to Cart
1. Customer selects products (JavaScript validation)
2. Click "Add to Cart" button
3. AJAX request with selected product IDs
4. `Cart_Handler::validate_add_to_cart()` validates
5. `Cart_Handler::add_cart_item_data()` stores selections
6. `Cart_Handler::calculate_cart_item_price()` updates price
7. Product added to cart with custom data
### Cart Display
1. WooCommerce loads cart
2. `Cart_Handler::get_cart_item_from_session()` restores data
3. `Cart_Handler::display_cart_item_data()` shows selections
4. Price calculated dynamically on each cart load
## Security Implementation
### Input Sanitization
- **Integers:** `absint()` for IDs and limits
- **Text:** `sanitize_text_field()` for modes and types
- **Textarea:** `sanitize_textarea_field()` for SKUs
- **Arrays:** `array_map()` with sanitization functions
### Output Escaping
- **HTML:** `esc_html()`, `esc_html_e()`
- **Attributes:** `esc_attr()`
- **URLs:** `esc_url()`
- **JavaScript:** Localized scripts with escaped data
### Validation
- Selection limit enforcement
- Product availability verification
- Cart data validation
- Nonce verification (via WooCommerce)
## Internationalization
### Text Domain
`wc-composable-product`
### Translation Functions
- `__()`: Return translated string
- `_e()`: Echo translated string
- `sprintf()` with `__()`: Variable substitution
### POT File
Generated template: `languages/wc-composable-product.pot`
**Supported Locales (per CLAUDE.md):**
- en_US (English)
- de_DE, de_DE_informal (German - Germany)
- de_CH, de_CH_informal (German - Switzerland)
- fr_CH (French - Switzerland)
- it_CH (Italian - Switzerland)
## Performance Considerations
### Caching
- Twig templates cached in `cache/` directory
- Auto-reload enabled in debug mode
- Optimized Composer autoloader
### Database Queries
- Efficient `WP_Query` for product selection
- Meta queries for SKU filtering
- Taxonomy queries for category/tag filtering
### Asset Loading
- Scripts only on relevant pages
- Minification ready (use build tools)
- Conditional enqueuing
## Extensibility
### Hooks & Filters
**Available Filters:**
- `wc_composable_settings`: Modify settings array
- `woocommerce_product_class`: Custom product class
- `product_type_selector`: Product type registration
**Customization Points:**
- Twig templates (override in theme)
- CSS styling (enqueue custom styles)
- JavaScript behavior (extend object)
### Developer API
```php
// Get composable product
$product = wc_get_product($product_id);
// Check if composable
if ($product->get_type() === 'composable') {
// Get available products
$products = $product->get_available_products();
// Get selection limit
$limit = $product->get_selection_limit();
// Calculate price
$price = $product->calculate_composed_price($selected_ids);
}
```
## Testing Checklist
### Admin Testing
- [ ] Product type appears in dropdown
- [ ] Composable Options tab displays
- [ ] Selection criteria toggle works
- [ ] Meta data saves correctly
- [ ] Settings page accessible
- [ ] Global defaults apply
### Frontend Testing
- [ ] Product selector renders
- [ ] Selection limit enforced
- [ ] Price calculation accurate (both modes)
- [ ] AJAX add-to-cart works
- [ ] Cart displays selections
- [ ] Checkout processes correctly
### Edge Cases
- [ ] Empty criteria (no products)
- [ ] Out of stock products excluded
- [ ] Invalid product selections rejected
- [ ] Multiple cart items unique
- [ ] Session persistence
## Known Limitations
1. **Variable Products:** Currently supports simple products in selection
2. **Grouped Products:** Cannot be used as selectable items
3. **Stock Management:** No automatic stock reduction for selected items
4. **Caching:** Template cache needs manual clearing after updates
## Future Enhancements
Potential features for future versions:
- Variable product support in selection
- Quantity selection per item (not just presence)
- Visual bundle previews
- Advanced pricing rules
- Stock management integration
- Product recommendations
- Selection templates/presets
- Multi-currency support enhancements
## Dependencies
### Runtime
- PHP 8.3+
- WordPress 6.0+
- WooCommerce 8.0+
- Twig 3.0 (via Composer)
### Development
- Composer for dependency management
- WP-CLI for i18n operations (optional)
## Deployment
### Production Checklist
1. Run `composer install --no-dev --optimize-autoloader`
2. Ensure `vendor/` directory is included
3. Ensure `cache/` directory is writable
4. Test on staging environment
5. Clear all caches after activation
6. Verify WooCommerce compatibility
### Release Package
Must include:
- All PHP files
- `vendor/` directory
- Assets (CSS, JS)
- Templates
- Language files
- Documentation
Must exclude:
- `.git/` directory
- `composer.lock`
- Development files
- `wp-core/`, `wp-plugins/` symlinks
## Support & Maintenance
### Code Standards
- WordPress Coding Standards
- WooCommerce best practices
- PSR-4 autoloading
- Inline documentation
### Version Control
- Semantic versioning (MAJOR.MINOR.PATCH)
- Changelog maintained
- Annotated git tags
- Development on `dev` branch
---
**Last Updated:** 2024-12-31
**Maintainer:** Marco Graetsch
**AI Assistant:** Claude.AI (Anthropic)
-150
View File
@@ -1,150 +0,0 @@
# Installation Guide
## Requirements
Before installing the WooCommerce Composable Products plugin, ensure your system meets these requirements:
- **PHP**: 8.3 or higher
- **WordPress**: 6.0 or higher
- **WooCommerce**: 8.0 or higher
- **Composer**: For dependency management
## Installation Steps
### 1. Upload Plugin Files
Upload the plugin directory to your WordPress installation:
```bash
/wp-content/plugins/wc-composable-product/
```
### 2. Install Dependencies
Navigate to the plugin directory and install dependencies:
```bash
cd /wp-content/plugins/wc-composable-product/
composer install --no-dev --optimize-autoloader
```
### 3. Activate Plugin
1. Log in to your WordPress admin panel
2. Navigate to **Plugins > Installed Plugins**
3. Find "WooCommerce Composable Products"
4. Click **Activate**
### 4. Configure Settings
After activation, configure the plugin:
1. Navigate to **WooCommerce > Settings**
2. Click on the **Composable Products** tab
3. Configure default settings:
- **Default Selection Limit**: Number of items customers can select (default: 5)
- **Default Pricing Mode**: Choose between "Sum of selected products" or "Fixed price"
- **Display Options**: Toggle product images, prices, and totals
## Creating Your First Composable Product
### Step 1: Create a New Product
1. Go to **Products > Add New**
2. Enter a product name (e.g., "Custom Sticker Pack")
### Step 2: Set Product Type
1. In the **Product Data** panel, select **Composable product** from the dropdown
### Step 3: Configure General Settings
In the **General** tab:
- Set a **Regular price** (used if pricing mode is "Fixed")
- Configure **Selection Limit** (leave empty to use global default)
- Choose **Pricing Mode** (leave empty to use global default)
### Step 4: Configure Composable Options
Click on the **Composable Options** tab:
1. **Selection Criteria**: Choose how to select available products
- **By Category**: Select product categories
- **By Tag**: Select product tags
- **By SKU**: Enter comma-separated SKUs
2. Based on your selection:
- **Categories**: Select one or more categories from the dropdown
- **Tags**: Select one or more tags from the dropdown
- **SKUs**: Enter SKUs like: `STICKER-01, STICKER-02, STICKER-03`
### Step 5: Publish
Click **Publish** to make your composable product live.
## Frontend Usage
When customers visit your composable product:
1. They see a grid of available products based on your criteria
2. They can select up to the configured limit
3. The total price updates in real-time (if using sum pricing mode)
4. Click "Add to Cart" to add the composition to their cart
5. Selected products are displayed in the cart
## Troubleshooting
### Plugin Won't Activate
- Ensure WooCommerce is installed and activated first
- Check PHP version (must be 8.3+)
- Verify Composer dependencies are installed
### Products Not Showing in Selector
- Check that products are published and in stock
- Verify the selection criteria (category/tag/SKU) is correct
- Ensure products match the criteria you configured
### Twig Template Errors
- Ensure the `vendor/` directory exists and contains Twig
- Run `composer install` again
- Check that the `cache/` directory is writable
### JavaScript Not Working
- Clear browser cache
- Check browser console for errors
- Ensure jQuery is loaded (WooCommerce includes it)
## Updating
When updating the plugin:
1. Deactivate the plugin
2. Replace plugin files
3. Run `composer install --no-dev --optimize-autoloader`
4. Reactivate the plugin
5. Clear all caches (WordPress, browser, CDN)
## Uninstallation
To completely remove the plugin:
1. Deactivate the plugin
2. Delete the plugin from the Plugins page
3. Optionally clean up database entries (WooCommerce will handle this automatically)
## Support
For issues and feature requests:
- GitHub: https://github.com/magdev/wc-composable-product/issues
- Documentation: See README.md
## Next Steps
- Customize the template by editing `templates/product-selector.twig`
- Modify styles in `assets/css/frontend.css`
- Translate the plugin using the provided `.pot` file
- Create categories/tags for easier product organization
+106 -27
View File
@@ -1,51 +1,112 @@
# WooCommerce Composable Products # WooCommerce Composable Products
Create composable products where customers can select a limited number of items from a configurable set of products. Create composable products where customers can select a limited number of items from a configurable set of products. Think of it as a "build your own gift box" or "create your sticker pack" feature.
## Description ## Key Features
This plugin adds a new product type to WooCommerce that allows customers to build their own product bundles by selecting from a predefined set of simple or variable products. Think of it as a "build your own gift box" or "create your sticker pack" feature.
### Key Features
- **Custom Product Type**: New "Composable Product" type in WooCommerce - **Custom Product Type**: New "Composable Product" type in WooCommerce
- **Flexible Selection**: Define available products by category, tag, or SKU - **Flexible Selection**: Define available products by category, tag, or SKU
- **Variable Product Support**: Automatically expands variable products into selectable variations
- **Stock Management**: Real-time stock validation, visual indicators, and automatic inventory tracking
- **Configurable Limits**: Set global or per-product selection limits - **Configurable Limits**: Set global or per-product selection limits
- **Pricing Options**: Fixed price or sum of selected products - **Pricing Options**: Fixed price or sum of selected products with full locale-aware formatting
- **Multi-language Support**: Fully translatable with i18n support - **Multi-language Support**: Fully translated in 6 locales (de_DE, de_CH, fr_CH, it_CH + informal variants)
- **Modern UI**: Clean interface built with Twig templates and vanilla JavaScript - **Modern UI**: Clean interface built with Twig templates and vanilla JavaScript
- **CI/CD**: Automated release workflow for Gitea
## Requirements ## Requirements
- PHP 8.3 or higher - PHP 8.3 or higher
- WordPress 6.0 or higher - WordPress 6.0 or higher
- WooCommerce 8.0 or higher - WooCommerce 8.0 or higher
- Composer (for dependency management)
## Installation ## Installation
1. Upload the plugin files to `/wp-content/plugins/wc-composable-product/` ### From Release Package
2. Run `composer install --no-dev` in the plugin directory
3. Activate the plugin through the 'Plugins' menu in WordPress 1. Download the latest release ZIP from the releases page
4. Configure global settings under WooCommerce > Settings > Composable Products 2. In WordPress admin, go to **Plugins > Add New > Upload Plugin**
3. Upload the ZIP file and click **Install Now**
4. Activate the plugin through the **Plugins** menu
5. Configure global settings under **WooCommerce > Settings > Composable Products**
### From Source
1. Upload the plugin directory to `/wp-content/plugins/wc-composable-product/`
2. Install dependencies:
```bash
cd /wp-content/plugins/wc-composable-product/
composer install --no-dev --optimize-autoloader
```
3. Activate the plugin through the **Plugins** menu in WordPress
4. Configure global settings under **WooCommerce > Settings > Composable Products**
## Usage ## Usage
### Creating a Composable Product
1. Go to Products > Add New
2. Select "Composable Product" as the product type
3. Configure product details:
- Set the selection limit (or use global default)
- Choose pricing mode (fixed or sum)
- Define available products by category, tag, or SKU
4. Publish the product
### Global Settings ### Global Settings
Navigate to WooCommerce > Settings > Composable Products to configure: Navigate to **WooCommerce > Settings > Composable Products** to configure:
- Default selection limit
- Default pricing mode - **Default Selection Limit**: Number of items customers can select (default: 5)
- Display options - **Default Pricing Mode**: Choose between "Sum of selected products" or "Fixed price"
- **Display Options**: Toggle product images, prices, and totals
### Creating a Composable Product
1. Go to **Products > Add New**
2. Select **Composable product** from the Product Data dropdown
3. In the **General** tab:
- Set a **Regular price** (used when pricing mode is "Fixed")
- Configure **Selection Limit** (leave empty to use global default)
- Choose **Pricing Mode** (leave empty to use global default)
4. Click the **Composable Options** tab:
- **Selection Criteria**: Choose how to define available products
- **By Category**: Select one or more product categories
- **By Tag**: Select one or more product tags
- **By SKU**: Enter comma-separated SKUs (e.g., `STICKER-01, STICKER-02`)
5. Click **Publish**
### Frontend Behavior
When customers visit a composable product page:
1. A grid of available products is displayed based on configured criteria
2. Customers select up to the configured limit via checkboxes
3. Total price updates in real-time (in sum pricing mode)
4. Stock indicators show availability (green/orange/red badges)
5. Click "Add to Cart" to add the composition to cart
6. Selected products are listed in the cart and checkout
## Troubleshooting
### Plugin Won't Activate
- Ensure WooCommerce is installed and activated first
- Check PHP version (must be 8.3+)
- Verify Composer dependencies are installed (`vendor/` directory exists)
### Products Not Showing in Selector
- Check that products are published
- Verify the selection criteria (category/tag/SKU) matches existing products
- Ensure the criteria type and values are saved in the Composable Options tab
### Twig Template Errors
- Ensure the `vendor/` directory exists and contains Twig
- Run `composer install` again
- Check that the `cache/` directory is writable
### Updating
1. Deactivate the plugin
2. Replace plugin files (or upload new release ZIP)
3. If installed from source: run `composer install --no-dev --optimize-autoloader`
4. Reactivate the plugin
5. Clear all caches (WordPress, browser, CDN)
## Development ## Development
@@ -60,10 +121,28 @@ composer install
### Translation ### Translation
Generate POT file: Generate POT file:
```bash ```bash
wp i18n make-pot . languages/wc-composable-product.pot wp i18n make-pot . languages/wc-composable-product.pot
``` ```
Compile translations:
```bash
for po in languages/*.po; do msgfmt -o "${po%.po}.mo" "$po"; done
```
### Creating Releases
Releases are automated via Gitea CI/CD. Push an annotated tag to trigger:
```bash
git tag -a v1.2.0 -m "Release v1.2.0"
git push origin v1.2.0
```
The workflow builds the release ZIP, compiles translations, generates checksums, and creates a Gitea release with attachments.
## License ## License
GPL v3 or later - see LICENSE file for details GPL v3 or later - see LICENSE file for details
@@ -74,4 +153,4 @@ Marco Graetsch
## Support ## Support
For issues and feature requests, please use the GitHub issue tracker. For issues and feature requests, please use the issue tracker.
Regular → Executable
View File
File mode changed.
Regular → Executable
View File
File mode changed.
Regular → Executable
+5 -3
View File
@@ -17,12 +17,14 @@
if (productType === 'composable') { if (productType === 'composable') {
$('.show_if_composable').show(); $('.show_if_composable').show();
$('.hide_if_composable').hide(); $('.hide_if_composable').hide();
$('#composable_product_data').show(); // Show the composable tab, then click it so WooCommerce's
$('.product_data_tabs .composable_options a').show(); // native tab system hides all other panels properly
$('.product_data_tabs li.composable_options').show();
$('ul.product_data_tabs li.composable_options a').trigger('click');
} else { } else {
$('.show_if_composable').hide(); $('.show_if_composable').hide();
$('.product_data_tabs li.composable_options').hide();
$('#composable_product_data').hide(); $('#composable_product_data').hide();
$('.product_data_tabs .composable_options a').hide();
} }
}).trigger('change'); }).trigger('change');
Regular → Executable
View File
File mode changed.
+2 -5
View File
@@ -200,7 +200,7 @@ class Cart_Handler {
return; return;
} }
// Use static flag to prevent multiple executions // Use static flag to prevent multiple executions within the same request
static $already_calculated = false; static $already_calculated = false;
if ($already_calculated) { if ($already_calculated) {
return; return;
@@ -208,13 +208,10 @@ class Cart_Handler {
foreach ($cart->get_cart() as $cart_item_key => $cart_item) { foreach ($cart->get_cart() as $cart_item_key => $cart_item) {
if (isset($cart_item['data']) && $cart_item['data']->get_type() === 'composable') { if (isset($cart_item['data']) && $cart_item['data']->get_type() === 'composable') {
if (isset($cart_item['composable_products']) && !isset($cart_item['composable_price_calculated'])) { if (isset($cart_item['composable_products'])) {
$product = $cart_item['data']; $product = $cart_item['data'];
$price = $product->calculate_composed_price($cart_item['composable_products']); $price = $product->calculate_composed_price($cart_item['composable_products']);
$cart_item['data']->set_price($price); $cart_item['data']->set_price($price);
// Mark as calculated to prevent re-calculation by other plugins
$cart->cart_contents[$cart_item_key]['composable_price_calculated'] = true;
} }
} }
} }
+13 -40
View File
@@ -110,24 +110,20 @@ class Product_Type extends \WC_Product {
'post_status' => 'publish', 'post_status' => 'publish',
'orderby' => 'title', 'orderby' => 'title',
'order' => 'ASC', 'order' => 'ASC',
'tax_query' => [],
]; ];
// Exclude composable products from selection // Exclude composable products using the product_type taxonomy
$args['meta_query'] = [ // (WooCommerce stores product types as taxonomy terms, NOT as postmeta)
$args['tax_query'] = [
'relation' => 'AND', 'relation' => 'AND',
[ [
'key' => '_product_type', 'taxonomy' => 'product_type',
'value' => 'composable', 'field' => 'slug',
'compare' => '!=', 'terms' => ['composable'],
'operator' => 'NOT IN',
], ],
]; ];
// Debug logging
if (defined('WP_DEBUG') && WP_DEBUG) {
error_log('Composable Product Criteria: ' . print_r($criteria, true));
}
switch ($criteria['type']) { switch ($criteria['type']) {
case 'category': case 'category':
if (!empty($criteria['categories'])) { if (!empty($criteria['categories'])) {
@@ -154,28 +150,20 @@ class Product_Type extends \WC_Product {
case 'sku': case 'sku':
if (!empty($criteria['skus'])) { if (!empty($criteria['skus'])) {
$skus = array_map('trim', explode(',', $criteria['skus'])); $skus = array_map('trim', explode(',', $criteria['skus']));
$args['meta_query'][] = [ $args['meta_query'] = [
'key' => '_sku', [
'value' => $skus, 'key' => '_sku',
'compare' => 'IN', 'value' => $skus,
'compare' => 'IN',
],
]; ];
} }
break; break;
} }
// Debug logging
if (defined('WP_DEBUG') && WP_DEBUG) {
error_log('Composable Product Query Args: ' . print_r($args, true));
}
$query = new \WP_Query($args); $query = new \WP_Query($args);
$products = []; $products = [];
// Debug logging
if (defined('WP_DEBUG') && WP_DEBUG) {
error_log('Composable Product Query Found: ' . $query->found_posts . ' posts');
}
if ($query->have_posts()) { if ($query->have_posts()) {
foreach ($query->posts as $post) { foreach ($query->posts as $post) {
$product = wc_get_product($post->ID); $product = wc_get_product($post->ID);
@@ -186,36 +174,21 @@ class Product_Type extends \WC_Product {
// Handle variable products by including their variations // Handle variable products by including their variations
if ($product->is_type('variable')) { if ($product->is_type('variable')) {
// Get variation IDs directly from the product
$variation_ids = $product->get_children(); $variation_ids = $product->get_children();
if (defined('WP_DEBUG') && WP_DEBUG) {
error_log('Variable product ' . $product->get_id() . ' has ' . count($variation_ids) . ' variations');
}
foreach ($variation_ids as $variation_id) { foreach ($variation_ids as $variation_id) {
$variation = wc_get_product($variation_id); $variation = wc_get_product($variation_id);
if ($variation && $variation->is_purchasable()) { if ($variation && $variation->is_purchasable()) {
$products[] = $variation; $products[] = $variation;
if (defined('WP_DEBUG') && WP_DEBUG) {
error_log('Added variation ' . $variation_id . ' - ' . $variation->get_name());
}
} }
} }
} elseif ($product->is_purchasable()) { } elseif ($product->is_purchasable()) {
// Simple and other product types
$products[] = $product; $products[] = $product;
if (defined('WP_DEBUG') && WP_DEBUG) {
error_log('Added simple product ' . $product->get_id() . ' - ' . $product->get_name());
}
} }
} }
} }
wp_reset_postdata(); wp_reset_postdata();
if (defined('WP_DEBUG') && WP_DEBUG) {
error_log('Total products available: ' . count($products));
}
return $products; return $products;
} }
Binary file not shown.
View File
File mode changed.
Binary file not shown.
View File
File mode changed.
Binary file not shown.
View File
File mode changed.
Binary file not shown.
View File
File mode changed.
Binary file not shown.
View File
File mode changed.
Binary file not shown.
View File
File mode changed.
View File
File mode changed.
Binary file not shown.
@@ -1 +0,0 @@
aec3bae001f0013322a73fa941169688 wc-composable-product-v1.0.0.zip
@@ -1 +0,0 @@
4a0f7ec2171aeabfdfe155419fd6124f35f3e14501ee2ca324bbab447259a8bb wc-composable-product-v1.0.0.zip
Binary file not shown.
@@ -1 +0,0 @@
0a60816bbc5a01c0057c1ffa72679d93 releases/wc-composable-product-v1.1.0.zip
@@ -1 +0,0 @@
645fdd68aca95cba77d961f3a48d41b9c12b3d17552572b7c039575dcfcab693 releases/wc-composable-product-v1.1.0.zip
Binary file not shown.
@@ -1 +0,0 @@
db09928aea6fffbf9c2e754d2264f2bc wc-composable-product-v1.1.1.zip
@@ -1 +0,0 @@
761eef69da910ecfdb20ceeed70b5d0381c7cab895e81a040d132cb0f88d749b wc-composable-product-v1.1.1.zip
Binary file not shown.
@@ -1 +0,0 @@
271aad47684ee8318a8824861d5fc387 wc-composable-product-v1.1.10.zip
@@ -1 +0,0 @@
63bfe97aa9fd98e74750786ed0e1579b069505e85558316f7042787994c856ac wc-composable-product-v1.1.10.zip
Binary file not shown.
@@ -1 +0,0 @@
63b105311dc1cc8ac67c05528ad02e30 wc-composable-product-v1.1.11.zip
@@ -1 +0,0 @@
214002a28a0426b4d2423f234d1dff63e4a8e58c6301cbd6eaed8db670db88c6 wc-composable-product-v1.1.11.zip
Binary file not shown.
@@ -1 +0,0 @@
546b9f9dd4ef0ec174d574af301a7bbc wc-composable-product-v1.1.12.zip
@@ -1 +0,0 @@
c445f1744d28cb53ef314f2dbb253aae31a7750f49f615f5c11a109274736f75 wc-composable-product-v1.1.12.zip
Binary file not shown.
@@ -1 +0,0 @@
49d0e5220e927a3b20c25ed5d475f72b wc-composable-product-v1.1.13.zip
@@ -1 +0,0 @@
6011f23f19da9c61c1953f9de110d073bb594fa5e75bf9745d37f666e2869873 wc-composable-product-v1.1.13.zip
Binary file not shown.
@@ -1 +0,0 @@
7b8bbd9c1e0a5db59f89ae677f095430 wc-composable-product-v1.1.14.zip
@@ -1 +0,0 @@
7c943fc5a85d5a48125aaf9f2e42434b370c4fa168ca33cd1e3485deb55302a5 wc-composable-product-v1.1.14.zip
Binary file not shown.
@@ -1 +0,0 @@
37cef191778b448dcbd2ae10141f64c6 wc-composable-product-v1.1.2.zip
@@ -1 +0,0 @@
191eae035b34ce8b33b90cf9d85ed54e493c1b471cda0efe5c992a512e91cc36 wc-composable-product-v1.1.2.zip
Binary file not shown.
@@ -1 +0,0 @@
9bbed416019a796b4d4a5ef72e016e1f wc-composable-product-v1.1.3.zip
@@ -1 +0,0 @@
0ca23ca12570f0e9c518514ffc5209d78c76c3295954d10ec74a28013a762956 wc-composable-product-v1.1.3.zip
Binary file not shown.
@@ -1 +0,0 @@
eae384e342450abd4ac83af0266ac764 wc-composable-product-v1.1.6.zip
@@ -1 +0,0 @@
d64f4f5f1a00d392989cb613780e5726106a08c6aace08e0c74c80553a0b0f1e wc-composable-product-v1.1.6.zip
Binary file not shown.
@@ -1 +0,0 @@
871fbb3b910380c0e43bcf1538408eda releases/wc-composable-product-v1.1.7.zip
@@ -1 +0,0 @@
866e7dd34431f4c881629fd8b59ddd3a27c7a45b7324a3d88cd064a3e01c1b83 releases/wc-composable-product-v1.1.7.zip
Binary file not shown.
@@ -1 +0,0 @@
78eee5eee4762c308c5d37d1aac06b04 wc-composable-product-v1.1.8.zip
@@ -1 +0,0 @@
d7d06e2a5d336609249f803b681cdf270dbe60d6fc28bdd6c451c6744d2fdab6 wc-composable-product-v1.1.8.zip
Binary file not shown.
@@ -1 +0,0 @@
a5b08f3613d1b1e8aba0c2b7b82a1582 wc-composable-product-v1.1.9.zip
@@ -1 +0,0 @@
f9fc497c0531c7ea828e164137f3db6e0a2755b899690dfb7d6411baf0c7a65a wc-composable-product-v1.1.9.zip
Regular → Executable
View File
File mode changed.
+2 -2
View File
@@ -4,7 +4,7 @@
* Plugin Name: WooCommerce Composable Products * Plugin Name: WooCommerce Composable Products
* Plugin URI: https://src.bundespruefstelle.ch/magdev/wc-composable-product * Plugin URI: https://src.bundespruefstelle.ch/magdev/wc-composable-product
* Description: Create composable products where customers select a limited number of items from a configurable set * Description: Create composable products where customers select a limited number of items from a configurable set
* Version: 1.1.14 * Version: 1.2.1
* Author: Marco Graetsch * Author: Marco Graetsch
* Author URI: https://src.bundespruefstelle.ch/magdev * Author URI: https://src.bundespruefstelle.ch/magdev
* License: GPL v3 or later * License: GPL v3 or later
@@ -20,7 +20,7 @@
defined('ABSPATH') || exit; defined('ABSPATH') || exit;
// Define plugin constants // Define plugin constants
define('WC_COMPOSABLE_PRODUCT_VERSION', '1.1.14'); define('WC_COMPOSABLE_PRODUCT_VERSION', '1.2.1');
define('WC_COMPOSABLE_PRODUCT_FILE', __FILE__); define('WC_COMPOSABLE_PRODUCT_FILE', __FILE__);
define('WC_COMPOSABLE_PRODUCT_PATH', plugin_dir_path(__FILE__)); define('WC_COMPOSABLE_PRODUCT_PATH', plugin_dir_path(__FILE__));
define('WC_COMPOSABLE_PRODUCT_URL', plugin_dir_url(__FILE__)); define('WC_COMPOSABLE_PRODUCT_URL', plugin_dir_url(__FILE__));