You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »




Installation




Before installing the extension, please make sure to Backup your web directory and store database


You will require to install MageDelight Base Extension first. If it is not installed then please download it from https://www.magedelight.com/pub/extensions/magedelight-base.zip and unzip the package file into the root folder of your Magento 2 installation.

Root Directory is - "app/code/magedelight/#YourExtensionName#"

  • Unzip the extension package file into the root folder of your Magento 2 installation.
  • Connect to SSH console of your server:
    • Navigate to the root folder of your Magento 2 setup
    • Run command as per below sequence,

      php bin/magento setup:upgrade

      php bin/magento setup:di:compile

      php bin/magento setup:static-content:deploy

      php bin/magento cache:clean

  • log out from the backend and log in again


If you are using Magento 2.3 or later then you do not need to activate license. Extension will be activated with silent activation mechanism and does not require activation keys to be entered manually.   



Backend Configuration (Admin side)



FieldDescription
Enable ModuleEnables or disables the Advanced Product Reviews module for the selected store view.
When enabled, all advanced review features become active on the storefront.
Allow to Post ReviewDetermines who is allowed to submit product reviews. Available options:
Everyone including Guest Users – Allows both registered customers and guest users to
   submit reviews.

Registered Customer – Only logged-in customers can submit reviews.

Verified Buyers – Only customers who have purchased the product can submit reviews,
   ensuring authentic and trustworthy feedback.
Enable Helpful Counts

Enables the “Was this review helpful?” voting feature, allowing customers to mark reviews

as helpful or not helpful. This helps surface the most useful reviews.

Enable Pros (What Works Well)

Displays an additional Pros field in the review form where customers can highlight positive

aspects of the product.

Enable Cons (What Could Be Better)

Displays a Cons field in the review form, allowing customers to share drawbacks or

improvement areas.

Enable Buyer Recommendation

Adds a recommendation option (for example, “I recommend this product”) in the review form

and displays the recommendation status on submitted reviews.

Enable Review Policy Consent

Displays a mandatory consent checkbox in the review form, requiring customers to agree to

the review policy or privacy guidelines before submitting a review.

Policy Content

Allows the admin to define and format the review policy or guidelines displayed to customers

using a rich text editor.

Enable CAPTCHA

Enables Google reCAPTCHA on the review submission form to prevent spam and automated

review submissions. CAPTCHA keys must be configured separately in Magento settings.

Restricted Keywords

A comma-separated list of restricted or inappropriate words. Reviews containing these keywords

will be blocked or restricted from submission.

Auto Approve Reviews

Automatically approves and publishes submitted reviews without manual admin moderation.

When disabled, reviews require admin approval before appearing on the storefront.

FieldDescription
Enable Video Upload

Allows customers to upload videos along with their product reviews.

When enabled, a video upload option appears in the review submission

form.

Is Video Required?

Makes video upload mandatory for submitting a review. If set to Yes,

customers must upload at least one video to submit their review.

Video File Type Support

Specifies the allowed video file formats for upload. Only videos with the

listed extensions (e.g., mp4, avi, mkv, MOV, webm) can be uploaded.

Max Video File Size (MB)

Defines the maximum allowed size for each uploaded video file. This value

must not exceed the server’s maximum upload limit. Default recommended

value is 10 MB.

Enable Image Upload

Allows customers to upload images with their product reviews. When enabled,

image upload fields are displayed in the review form.

Is Image Required?

Makes image upload mandatory for submitting a review. If set to No, images

are optional for customers.

Image File Type Support

Specifies the supported image file formats for upload. Common formats include

JPG, PNG, and JPEG. Note: Magento does not natively support GIF and WEBP

uploads.

Max Image File Size (KB)

Defines the maximum allowed size for each uploaded image file. The value should

be within the server’s configured upload size limit.

Max Images Upload Count

Sets the maximum number of images a customer can upload per review. Helps

control storage usage and review layout consistency.

Limit Review Media to Display on All Media Page

Limits the total number of review images and videos displayed on the All Media

page. This helps improve page performance and load time.

FieldDescription
Enable Admin Response Notification

When enabled, customers receive an email notification whenever an admin

responds to their product review.

Admin Response Email Sender

Specifies the sender identity used for emails sent to customers regarding

admin responses to reviews.

Admin Response Email Template

Selects the email template used to notify customers when an admin replies

to their review.

Enable Admin Review Notification

When enabled, the admin receives an email notification whenever a customer

submits a new product review.

Admin Review Email Sender

Specifies the sender identity used for emails sent to the admin about new

product reviews.

Admin Review Email Template

Selects the email template used to notify the admin when a new review is

submitted by a customer.

Admin CC Email IDs

Allows you to add one or more email addresses (comma-separated) to

receive a carbon copy (CC) of admin review notification emails.

FieldDescription
Review Details Page URL Key

Defines the URL key used for the review details page. The review details page URL format

will be: {product-url-key}/{review-details-page-url-key}. Only hyphens (-) are allowed as

separators.

All Media URL Key

Defines the URL key for the All Media page, where all review images and videos are

displayed. The page URL format will be: {product-url-key}/reviews/{all-media-url-key}.

Only hyphens (-) are allowed as separators.

Display Top Reviews On Product Page

Specifies the number of top reviews displayed directly on the product detail page. This

helps showcase the most relevant reviews without overcrowding the page.

Enable Permalink

Enables or disables permanent URLs for individual reviews. When enabled, each review

can be accessed using a unique URL in the format: {product-url-key}/reviews/{review-id}.

FieldDescription
Enable Order Experience Rating

Enables or disables the Order Experience Rating feature. When enabled, customers can rate

their overall order experience in addition to product reviews.

Select Order Rating Category

Defines the rating category used for order experience reviews. Available options:

Order Rating Category – Default category for collecting overall order experience feedback.

Shipping Testing – Allows collecting ratings specifically related to shipping and delivery experience.

Select Customer Groups

Specifies which customer groups are allowed to see and submit the order experience rating form. Only

the selected groups (e.g., General, Retailer, Wholesale) will be eligible.

Enable Order Experience Rating ReminderEnables email reminders prompting customers to rate their order experience after order completion.
Order Review Email Template

Selects the email template used for sending order experience rating reminder emails. Available options:

MageDelight – Order Review Reminder Email (Default) – Default reminder email for order experience ratings.

MageDelight – Product Review Reminder Email – Reminder email focused on product reviews.

MageDelight – Order Review Reminder Email – Standard order experience reminder email.

MageDelight – Shipping Review Reminder Email – Reminder email focused on shipping experience reviews.

MageDelight – Product Review Promotional Coupons Email – Reminder email that includes promotional

coupons for product reviews.

Order Review Email SenderDefines the sender identity used for order experience rating reminder emails (for example, General Contact).
Order Review Reminder Days

Specifies the number of days after order completion when the order experience rating reminder email is sent

to the customer.

CRON Settings

Defines the frequency at which the CRON job runs to process and send order experience rating reminder

emails (for example, Daily).

CRON TimeSpecifies the exact execution time (Hours : Minutes : Seconds) for the CRON job based on the selected frequency.

FieldDescription
Enable Order Experience Rating

Enables or disables the Shipping Experience Rating feature. When enabled, customers can

rate their shipping and delivery experience separately from product and order reviews.

Select Order Rating Category

Defines the rating category used for shipping experience reviews. Available option:

Shipping Rating Category – Used to collect feedback specifically related to shipping,

delivery speed, and handling.

Select Customer Groups

Specifies which customer groups are allowed to see and submit the shipping experience

rating form. Only the selected groups (e.g., General, Retailer, Wholesale) will be eligible.

Enable Order Experience Rating Reminder

Enables email reminders prompting customers to rate their shipping experience after

shipping completion.

Order Review Email Template

Selects the email template used for sending shipping experience rating reminder emails.

Available options:

MageDelight – Shipping Review Reminder Email (Default) – Default email template for

shipping experience reminders.

MageDelight – Product Review Reminder Email – Reminder email focused on product

reviews.

MageDelight – Order Review Reminder Email – Reminder email focused on overall order

experience.

MageDelight – Shipping Review Reminder Email – Standard shipping experience reminder

email.

MageDelight – Product Review Promotional Coupons Email – Reminder email that includes

promotional coupons for product reviews.

Order Review Email Sender

Defines the sender identity used for shipping experience rating reminder emails

(for example, General Contact).

Order Review Reminder Days

Specifies the number of days after shipping completion when the shipping experience rating

reminder email is sent to the customer.

CRON Settings

Defines the frequency at which the CRON job runs to process and send shipping experience

rating reminder emails (for example, Daily).

CRON Time

Specifies the exact execution time (Hours : Minutes : Seconds) for the CRON job based on

the selected frequency.

FieldDescription
Send Promotional Coupons After

Defines when promotional coupons are sent to customers after a review action. Available

options:

Review Posted – Sends the promotional coupon immediately after the customer submits

a review, before admin approval.

Review Approved – Sends the promotional coupon only after the review is approved by

the admin. This option helps prevent misuse and ensures only valid reviews receive coupons.

CRON Settings

Specifies how frequently the CRON job runs to process and send promotional coupons

(for example, Monthly).

CRON Time

Defines the exact execution time (Hours : Minutes : Seconds) at which the CRON job will run

based on the selected frequency.

FieldDescription
Enable Report

Enables or disables the review reporting feature on the storefront. When enabled, customers

can report reviews they believe are inappropriate or violate marketplace policies.

Quick Action on Report

Defines the default system action applied when a review is reported by a customer. Commonly used

option:

Moderated – The reported review is flagged and moved into moderation, requiring admin

review before further action.

Pending – The review status is changed to pending and awaits admin approval.

Rejected – The review is automatically rejected upon being reported.

Admin Email TemplateSelects the email template used to notify the admin when a review is reported by customers.
Email SenderSpecifies the sender identity used for admin report notification emails (for example, General Contact).
Admin CC Email IDs

Allows adding one or more email addresses (comma-separated) to receive a carbon copy (CC) of reported

review notification emails.

Moderation Criteria

Defines the list of reasons displayed to customers when reporting a review. Multiple criteria can be configured

using comma-separated values (for example, Off-topic, Inappropriate, Fake, Abusive).

FieldDescription
Index Review Pages

Allows search engines to index review pages. When enabled, review-related pages can

appear in search engine results, improving organic visibility.

Follow Review Pages

Controls whether search engines are allowed to follow links on review pages. Setting this to

No prevents passing link equity from review pages to other URLs.

Meta Title Prefix

Defines the prefix added to the meta title of review pages. This helps standardize review page

titles for better search visibility (default value: “Reviews of”).

Enable Google Review Schema

Enables structured data (schema markup) for product reviews. This allows search engines to

display rich results such as star ratings and review counts in search listings.

Backend Functionality


Rating Attributes

  • Path: MageDelight → Advanced Review → Rating Attributes
Field / SectionDescription
Rating Attributes Page

Displays a list of all rating attributes used in product, order, or shipping reviews. These

attributes define the individual criteria customers rate (for example, quality, fitting, stitching).

Add New Rating Attribute

Allows the admin to create a new rating attribute. Clicking this button opens a form to define

a new rating criterion that can be used in reviews.

Search by Keyword

Enables admins to quickly search rating attributes using keywords such as rating code or rating

name.

Filters

Allows filtering rating attributes based on available columns such as status or sort order to

narrow down results.

ExportEnables exporting the rating attributes list for reporting or backup purposes.
ColumnsAllows admins to show or hide columns in the grid view based on preference.
IDDisplays the unique system-generated identifier for each rating attribute.
Rating Code

A unique internal code for the rating attribute. This code is used internally by Magento

and should be lowercase and underscore-separated.

Rating Name

The human-readable name of the rating attribute displayed to customers on the

storefront (for example, “Girls Fabric Quality”).

Sort Order

Determines the display order of rating attributes on the review form. Lower values

are displayed first.

Status

Indicates whether the rating attribute is active or inactive. Only enabled attributes

are visible to customers during review submission.

ActionProvides actions for each rating attribute, such as editing or disabling the attribute.
Actions (Bulk)

Allows performing bulk actions (such as enable or disable) on multiple rating

attributes at once.

Pagination

Controls how many rating attributes are displayed per page and allows navigation

between pages.

Add New Rating Attribute

  • Path: MageDelight → Advanced Review → Rating Attributes → Add New Rating Attribute
FieldDescription
Status

Enables or disables the rating attribute. Only Enabled rating attributes are visible to

customers on the review form.

Rating Attribute Name

The display name of the rating attribute shown to customers on the storefront (for example

, Girls Pants Quality). This should be clear and customer-friendly.

Rating Attribute Identifier

A unique internal identifier for the rating attribute. It is used internally by Magento and

should be lowercase, unique, and use underscores (_) instead of spaces

(for example, girls_pants_quality).

Associated Rating Categories

Defines the rating categories where this rating attribute will be used. The attribute will

appear on review forms only for the selected categories (for example, product category,

shipping category, or custom rating categories). Multiple categories can be selected.

Sort Order

Determines the display position of this rating attribute in the review form. Lower values

appear first, allowing you to prioritize important rating criteria.

Save

Saves the rating attribute configuration and makes it available for use in reviews based

on the selected categories.

BackReturns to the Rating Attributes listing page without saving changes.

Rating Category Management

  • Path: MageDelight → Advanced Review → Rating Category


Field / SectionDescription
Rating Category Management Page

Displays all rating categories used to group rating attributes for Product, Order, and

Shipping reviews. Rating categories control where and how rating attributes appear on the

storefront review forms.

Add New Rating Category

Allows the admin to create a new rating category. Clicking this button opens a form to define

a new category and associate rating attributes with it.

Search by KeywordEnables searching rating categories by name or category code for quick access.
FiltersAllows filtering the grid based on fields such as review type, status, or sort order.
ColumnsAllows admins to show or hide grid columns based on preference.
IDDisplays the unique system-generated identifier for each rating category.
Rating Category Name

The human-readable name of the rating category shown in admin configuration

(for example, Product Rating Category or Shipping Rating Category).

Rating Category Code

A unique internal identifier for the rating category. This code is used internally and should

be lowercase with underscores (for example, product_rating_category).

Review Type

Defines the type of review this category applies to:

Product Review – Used for product detail page reviews.

Order Review – Used for overall order experience reviews.

Shipping Review – Used for shipping and delivery experience reviews.

Rating Attribute Names

Displays the list of rating attributes associated with this category. These attributes will

appear as individual rating criteria on the review form.

Product Categories

Defines which Magento product categories this rating category applies to. The rating

category will only appear for products belonging to these categories.

Sort Order

Determines the display priority of the rating category. Lower values are displayed first

when multiple categories are available.

Status

Indicates whether the rating category is active or inactive. Only enabled categories are

available for use in reviews.

Action

Provides actions for each rating category, such as editing or managing the category

configuration.

Actions (Bulk)

Allows performing bulk actions (such as enable or disable) on multiple rating

categories at once.

Pagination

Controls the number of rating categories displayed per page and allows navigation

between pages.

Add New Rating Category

  • Path: MageDelight → Advanced Review → Rating Category → Add New Rating Category
FieldDescription
Enable Rating Category

Enables or disables the rating category. Only enabled rating categories are available for use

in review forms on the storefront.

Rating Category Name

The display name of the rating category shown in the admin and used to group related

rating attributes (for example, womens pant).

Rating Category Identifier

A unique internal identifier for the rating category. It should be lowercase, unique, and use

underscores (_) instead of spaces (for example, womens_pant).

Select Review Type

Defines the type of review this category applies to. Available options typically include

Product Review, Order Review, or Shipping Review. This determines where the

category appears in the review flow.

Store View

Specifies the store view(s) where this rating category will be available. Selecting

multiple store views allows the category to be used across different storefronts.

Rating Attributes

Allows selection of one or more rating attributes that belong to this category.

These attributes will appear as individual rating criteria when customers submit a review.

Sort Order

Determines the display priority of the rating category when multiple categories are

available. Lower values appear first.

Save

Saves the rating category configuration and makes it available for use based on

the selected review type and store view.

BackReturns to the Rating Category Management grid without saving changes.

  • After creating a Rating Category, it must be assigned to the relevant product category so that the correct rating attributes appear on the product review form.
  • For example, after creating the rating category “womens pant”, navigate to Catalog → Categories → Women → Bottoms → Pants.
  • In the category edit page, expand Advanced Review Ratings by MageDelight and select womens pant from the Rating Category Name dropdown.
  • Save the category to apply the configuration. This ensures that only category-specific rating attributes are shown for women’s pants products.


Step / FieldDescription
Navigate to CategoryGo to Catalog → Categories → Women → Bottoms → Pants.
Advanced Review SectionExpand Advanced Review Ratings by MageDelight on the category edit page.
Rating Category NameSelect womens pant from the dropdown list.
Save CategoryClick Save to apply the rating category to the Pants product category.
  • Rating Categories must be created first before they can be assigned to product categories.

  • Each product category can have one relevant rating category to keep reviews focused and meaningful.

  • Products under Women → Bottoms → Pants will now show only the rating attributes configured under the womens pant rating category.

  • This helps collect category-specific feedback instead of generic reviews.

Manage Reviews

  • The Manage Reviews section allows administrators to view, moderate, and manage all product reviews submitted by customers. From this screen, admins can review customer details, product information, ratings, review content, verification status, and approval state. It also provides quick access to edit reviews, track helpful/not-helpful votes, and monitor reminder and verification details across store views.
  • Path: MageDelight → Advanced Review → Manage Reviews
Column / SectionDescription
IDUnique identifier assigned to each review.
Customer Name / NicknameDisplays the reviewer’s name and chosen nickname, if provided.
Customer EmailEmail address of the customer who submitted the review.
Product NameName of the product for which the review was submitted.
Product SKUSKU of the reviewed product.
RatingOverall rating score given by the customer.
Review TitleTitle or short summary of the review.
Review TextDetailed review content submitted by the customer.
Verified Order NumberDisplays the order number if the review is linked to a verified purchase.
Verified PurchaseIndicates whether the review is from a verified buyer.
StatusShows the current review status (for example, Pending or Approved).
Reminder Status / DateIndicates whether a review reminder was sent and the reminder date.
Helpful / Not Helpful CountDisplays how many users marked the review as helpful or not helpful.
Created At / Updated AtShows when the review was created and last updated.
Store ViewIndicates the store view in which the review was submitted.
ActionAllows admins to edit the review details or take moderation actions.

Add New Reviews

  • The Add New Review screen allows administrators to manually create or edit a product review on behalf of a customer. From this page, the admin can define the review status, customer details, rating, review content, pros and cons, media uploads, and recommendation flag. Admins can also add an official response and choose whether the customer should be notified after saving the review.
  • Path: MageDelight → Advanced Review → Manage Reviews → Add New Review


FieldDescription
Status

Sets the review status (for example, Approved or Pending). Approved reviews are

immediately visible on the storefront.

Customer EmailEmail address of the customer submitting the review.
Customer NameName of the customer associated with the review.
Customer CityCity of the customer (optional informational field).
Author Display NameName shown publicly on the storefront as the review author.
Summary RatingDisplays the calculated summary rating based on individual ratings.
Product RatingStar rating given to the product.
Store ViewSelects the store view in which the review will be published.
Review TitleShort headline for the review (maximum 50 characters).
Review TextDetailed customer feedback about the product (maximum 500 characters).
Product AdvantagesAllows adding product pros or positive points.
Product DisadvantagesAllows adding product cons or improvement areas.
Upload Review VideoEnables uploading a video review, if media uploads are enabled.
Recommend ProductIndicates whether the customer recommends the product.
Admin ResponseAllows the admin to add an official response to the review.
Notify CustomerSends an email notification to the customer when enabled.
Save ReviewSaves the review and applies all configured details.
BackReturns to the review list without saving changes.

  • This section allows the admin to assign category-specific rating attributes, upload review images, link the review to a specific product, and capture review metadata. Admins can rate individual attributes (such as Color or Fabric Quality), attach images to enhance authenticity, select the reviewed product, and track metadata like review date and IP information for moderation and audit purposes.
  • Path: MageDelight → Advanced Review → Manage Reviews → Add New Review
Section / FieldDescription
Ratings Category

Displays rating attributes mapped to the product’s rating category. Admins can select

attributes and assign star ratings for each criterion.

Add Rating AttributesAllows adding more rating attributes dynamically to the review.
Attribute Rating

Star-based rating assigned for each selected attribute

(for example, Color, Fabric Quality).

Review Images

Enables uploading product images related to the review to improve credibility

and visual validation.

Products Fieldset

Allows selecting the exact product for which the review is being created. Only

one product can be associated with a review.

Review Metadata

Displays internal metadata such as review date, IP address, user agent, and

geo-location for tracking and moderation purposes.







Frontend Functionality














Demo


Click here to visit frontend.

Click here to visit backend admin panel.

FAQs


Click here to visit FAQs.

Support


Click here to raise a support ticket using your MageDelight account.

Additional Services


Click here to get the customized solution for this extension.



Thank you for choosing MageDelight!



  • No labels