Skip to content

Product Description

Overview

Section titled “Overview”

Displays the full product description on product detail pages. This block renders the description text synced from BigCommerce, which typically includes product details, features, materials, care instructions, or other relevant information.

Requirements

Section titled “Requirements”
  • Parent block: Must be inside commerce-connect/product-details-page
  • BigCommerce data: Product description field

Configuration

Section titled “Configuration”

Attributes

Section titled “Attributes”
  • settingsId (string) - Settings configuration identifier
    • Default: ""
  • dropzone (string) - Dropzone identifier for block placement
    • Default: ""

Block Support

Section titled “Block Support”
  • HTML editing: Not supported
  • Multiple instances: Not allowed (only one per product page)
  • Spacing: Margin control available

Usage

Section titled “Usage”

Placement

Section titled “Placement”

This block must be placed inside the Single Product template (Product Details Page block). It cannot be used outside of this context.

Common Patterns

Section titled “Common Patterns”

From the demo video script, the description block typically appears below the purchase controls:

Product Title
Product Pricing
Product Buy Button
→ Product Description ← (Full product details)
Product Reviews
Related Products

The description content is managed in BigCommerce’s product management interface. To edit the description:

  1. Go to Commerce Connect > Products in WordPress® admin
  2. Find the product and click “Edit in BigCommerce”
  3. Update the description in BigCommerce
  4. Changes sync automatically to WordPress®

Technical Details

Section titled “Technical Details”

CSS Classes

Section titled “CSS Classes”
  • Uses standard block wrapper attributes
  • Dropzone ID applied when specified

Data Source

Section titled “Data Source”

The block uses context provided by the parent Product Details Page block:

  • commerce-connect/singleProductRefinedPayload - Simplified product data including description
  • commerce-connect/singleProductFullPayload - Complete product information
  • commerce-connect/singleProductSelectedProduct - Currently selected product
  • commerce-connect/singleProductDropzones - Available dropzone positions
  • commerce-connect/singleProductIsFetching - Loading state indicator

Product descriptions are synced from BigCommerce and stored in WordPress®. When a product description changes in BigCommerce, the update syncs to WordPress® automatically.

Troubleshooting

Section titled “Troubleshooting”

Description not displaying

Section titled “Description not displaying”
  • Verify the block is inside a Product Details Page parent block
  • Check that the product has a description set in BigCommerce
  • Ensure the product data has synced from BigCommerce

Description appears empty or as placeholder

Section titled “Description appears empty or as placeholder”
  • Product may not have a description set in BigCommerce
  • Check the sync status in the Commerce Connect admin
  • Edit the product in BigCommerce to add description content

HTML formatting lost

Section titled “HTML formatting lost”
  • BigCommerce description field supports HTML formatting
  • Verify the description HTML is valid in BigCommerce
  • Check that special characters or formatting are properly encoded

Want to edit description in WordPress®

Section titled “Want to edit description in WordPress®”

The product description cannot be edited directly in WordPress® because BigCommerce is the source of truth for product data. This prevents conflicts between the two systems. To update the description:

  • Use “Edit in BigCommerce” from the Products admin page in WordPress®
  • Make changes in BigCommerce’s product management interface
  • Changes sync automatically to WordPress®