Modular Merchant
QuickCode™ Glossary
{REVIEW-COMPOSITE-RANK}
QuickCode Tag Glossary Home
See also:
Knowledge Base
Articles in this category:
{FIELD-REVIEW-CRITERIA-MENU}

{FIELD-REVIEW-CRITERIA}

{FIELD-REVIEW-DETAILS}

{FIELD-REVIEW-SORT}

{IF-CUSTOMER-HAS-VOTED-ON-REVIEW-BEGIN}

{IF-CUSTOMER-HAS-VOTED-ON-REVIEW-END}

{IF-REVIEW-CRITERIA-BEGIN}

{IF-REVIEW-CRITERIA-END}

{IF-REVIEWER-AUTHORIZED-BEGIN}

{IF-REVIEWER-AUTHORIZED-END}

{IF-REVIEWS-BEGIN}

{IF-REVIEWS-END}

{IF-USING-PRODUCT-REVIEWS-BEGIN}

{IF-USING-PRODUCT-REVIEWS-END}

{NUMBER-OF-REVIEWS}

{REVIEW-AUTHOR}

{REVIEW-AVERAGE-RANK}

{REVIEW-BLOCK-BEGIN}

{REVIEW-BLOCK-END}

{REVIEW-COMPOSITE-RANK}

{REVIEW-CREATE-DATE}

{REVIEW-CRITERIA-BLOCK-BEGIN}

{REVIEW-CRITERIA-BLOCK-END}

{REVIEW-CRITERIA-DESCRIPTION}

{REVIEW-CRITERIA-NAME}

{REVIEW-CRITERIA-RANK}

{REVIEW-CRITERIA-SID}

{REVIEW-DETAIL}

{REVIEW-SID}

{REVIEW-SUMMARY}

{REVIEW-TOGGLE-DISPLAY-TAG}

{REVIEW-VOTES-HELPFUL}

{REVIEW-VOTES-TOTAL}

{REVIEW-VOTES-UNHELPFUL}

{URL-REVIEW-VOTE-IS-HELPFUL}

{URL-REVIEW-VOTE-IS-UNHELPFUL}

Reviews > {REVIEW-COMPOSITE-RANK}
<< {REVIEW-BLOCK-END} {REVIEW-CREATE-DATE} >>
{REVIEW-COMPOSITE-RANK} Updated: 11/26/2012

This QuickCode Tag is used to display the average criteria rating of all of the reviews for a specific product.

In order to enable review criteria, a store admin must first create one or more criteria group, and apply the criteria to one or more products. The options to add a criteria group are located in the store's admin area at [Modules > Product Reviews > Add a Ranking Criteria Group].

Once a criteria group has been created and applied to a product, reviewers will be able to assign rating between 1 and 5 for each criteria, as part of the product review. The {REVIEW-COMPOSITE-RANK} QuickCode Tag will display the average of all of the ratings from all reviews for a specific product.

Requirements / Prerequisites

The {REVIEW-COMPOSITE-RANK} QuickCode Tag is compatible with the product detail page template, including product.template.php, upsell.template.php, and downsell.template.php.

The {REVIEW-COMPOSITE-RANK} QuickCode Tag should ideally be used after the {IF-USING-PRODUCT-REVIEWS-BEGIN} and {IF-REVIEWS-BEGIN} QuickCode Tags, and before the {REVIEW-BLOCK-BEGIN} QuickCode Tag. That way, the overall average rating will only be display if the Product Reviews module is enabled, and if the product has at least one review, and will only be displayed once for the entire review block, instead of being repeated for each review within the block.

The {REVIEW-COMPOSITE-RANK} QuickCode Tag might also optionally be enclosed between the {IF-REVIEW-CRITERIA-BEGIN} and {IF-REVIEW-CRITERIA-END} QuickCode Tags.

Example of Use

If product.template.php contains the following:

{IF-USING-PRODUCT-REVIEWS-BEGIN}
    {IF-REVIEWS-BEGIN}
        {NUMBER-OF-REVIEWS} Reviews of {PRODUCT-NAME} {IF-REVIEW-CRITERIA-BEGIN}(Average rating: {REVIEW-COMPOSITE-RANK}){IF-REVIEW-CRITERIA-END}
                {REVIEW-BLOCK-BEGIN}

And the product Sandwich has five reviews, with average ratings of 3, 4, 3, 3, and 5, for a total composite rating of 3.6, the Sandwich product detail page would display the following:

5 Reviews of Sandwich (Average rating: 3.6)

Source Code Source Code Updated:
When a web page using a template that contains this QuickCode Tag is viewed in the storefront, the {REVIEW-COMPOSITE-RANK} QuickCode Tag is changed into the source code below prior to the web page being displayed.
LOG IN TO ADD COMMENTS
  Copyright © 2001 - 2024 Modular Merchant™. All rights reserved.
Modular Merchant | Privacy Policy | Legal Statement | Terms of Service | Contact Us | Site Map