Configure a Shopreview widget
Display store reviews and ratings throughout your site with the Shopreview widget. This guide covers widget configuration and placement.
Widget Overview
The Shopreview widget displays:
- Average score summary
- Star ratings
- Individual reviews
- Link to review page
Creating a Widget
Step 1: Add Widget
- Go to Content → Widgets
- Click Add Widget
- Select Type: Shopreview
- Select your Design Theme
- Click Continue
Step 2: Widget Properties
Configure the storefront properties:
| Setting | Description |
|---|---|
| Widget Title | Internal name for reference |
| Assign to Store Views | Which stores display this widget |
| Sort Order | Widget priority (lower = higher priority) |
Step 3: Layout Updates
Define where the widget appears:
- Click Add Layout Update
- Select Display on: Where to show the widget
- Select Container: Page area for placement
Common placement options:
- All Pages → Sidebar Additional
- Specific Page → Main Content Area
- Category Pages → After Page Header
Step 4: Widget Options
Configure the display settings:
| Option | Description |
|---|---|
| Sidebar Title | Header text above widget |
| Review Form | Select which form's reviews to display |
| Display Summary of Average Score | Show numerical average |
| Display Average Score in Stars | Show star rating visual |
| Number of Stars | Star scale (usually 5) |
| Display Reviews | Show individual reviews |
| Number of Reviews to Show | How many reviews to display |
| Character Length of Description | Truncate review text length |
| Sort Reviews By | Order of displayed reviews |
Click Save when configured.
Widget Options Explained
Sidebar Title
The heading text displayed above the widget content.
Examples:
- "Customer Reviews"
- "What Our Customers Say"
- "Store Ratings"
Review Form Selection
Choose which review form's data to display. The widget pulls:
- Average rating from all approved reviews
- Individual reviews from the selected form
- Rating distribution data
Average Score Display
Display Summary of Average Score
When enabled, shows the numerical average:
4.7 out of 5
Display Average Score in Stars
When enabled, shows a visual star rating:
★★★★☆
Both can be enabled simultaneously for maximum impact.
Number of Stars
Set the rating scale:
- 5 stars - Most common, familiar to users
- 10 stars - More granular ratings
Match this to your review form's rating field scale.
Review Display
Display Reviews
Enable to show individual customer reviews below the average score.
Number of Reviews to Show
Set how many reviews appear in the widget:
- 3-5 for sidebar placement
- 5-10 for main content area
- Consider page load impact for higher numbers
Character Length of Description
Truncate long reviews to keep the widget compact:
- 100-200 characters for sidebar
- 300-500 characters for main content
- Set 0 or empty for full text
Sort Reviews By
Control review order:
- Newest First - Show recent feedback
- Highest Rated - Showcase best reviews
- Oldest First - Historical order
Widget Placement Examples
Sidebar Widget
Ideal for:
- Homepage sidebar
- Category page sidebars
- CMS page sidebars
Settings:
- Number of Reviews: 3
- Character Length: 150
- Stars: Enabled
- Average Score: Enabled
Homepage Featured Reviews
Ideal for:
- Homepage main content
- Landing pages
- About Us page
Settings:
- Number of Reviews: 5-6
- Character Length: 300
- Both score displays enabled
- Horizontal layout
Footer Trust Badge
Ideal for:
- Site-wide footer
- Trust building
Settings:
- Average Score: Enabled
- Stars: Enabled
- Reviews: Disabled or 1-2 recent
- Minimal layout
Multiple Widgets
You can create multiple widgets for different purposes:
Scenario 1: Different Forms
- Widget A shows "General Store Reviews"
- Widget B shows "Delivery Feedback"
Scenario 2: Different Placements
- Widget A in sidebar (compact, 3 reviews)
- Widget B on homepage (featured, 6 reviews)
Scenario 3: Different Pages
- Widget A on all pages
- Widget B only on checkout success page
Styling Considerations
Theme Compatibility
The widget inherits your theme's styling. For custom styling:
- Override CSS in your theme
- Widget uses standard Magento widget classes
- Star ratings use CSS-based rendering
Responsive Design
Consider mobile display:
- Sidebars often collapse on mobile
- Test character lengths on mobile screens
- Ensure star ratings scale properly
Performance
Caching
Widgets are cached by Magento's full page cache:
- New reviews appear after cache refresh
- Consider cache lifetime settings
- Widget content updates on cache clear
Loading Optimization
For many reviews:
- Limit displayed reviews to essential number
- Use character truncation
- Consider lazy loading in theme
Troubleshooting Widgets
Widget Not Appearing
- Verify widget is saved and enabled
- Check store view assignment
- Verify layout update placement
- Clear cache:
bin/magento cache:flush - Check theme compatibility
Wrong Reviews Showing
- Verify correct Review Form is selected
- Check reviews are approved (Allowed status)
- Verify store view assignments match
Styling Issues
- Check theme CSS conflicts
- Verify widget container has proper styles
- Test with default Magento theme
Best Practices
Trust Building
- Place widget prominently on homepage
- Show average score on product pages
- Include in footer for site-wide trust
Content Strategy
- Keep sidebar widgets compact
- Feature best reviews on key pages
- Update widget settings based on review volume
Performance
- Don't overload pages with multiple large widgets
- Use appropriate character limits
- Test page load times with widgets enabled
Need More Help?
Documentation:
- All Help Articles - Complete documentation overview
Support:
- Contact Support - Get help from our team