Channel Ratings Documentation

Rating - Comment With Rating Tag

{exp:comment:form}

Parameters

Parameter Description
rating:enabled REQUIRED: You need to set this parameter to “yes” for the ratings function to work.
rating:required Is a rating required? Set this to “no” if you don’t want to force people to submit a rating along with their comments
rating:collection A specific ratign collection
rating:min_value This parameter is used to force the user to have to submit a value equal to or higher than the specified value.
rating:max_value This parameter is used to force the user to have to submit a value equal to or lower than the specified value.
rating:allow_guests Allow guest submissions?
rating:allow_multiple Allow multiple submissions? Lets say you want to allow people to rate an entry multiple times.
rating:return This parameter allows you to define where the user will be returned after submitting a rating. The parameter can be defined in two ways:
rating:prefix This parameter allows you to change the default variable prefix used. This is especially useful when you are nesting tags to avoid variable collisions.

Variable Pairs

{rating:fields} Variable Pair Description
{rating:field_title} The rating field title
{rating:form_name} The form input name for this field

Conditionals

Conditional Description
{if rating:no_access} This tag will conditionally display the code inside the tag if the user has no access to view the form. This can happen if the user is banned OR is a guest and gues access is not enabled
{if rating:already_rated} This tag will conditionally display the code inside the tag if you have already submitted a comment WITH rating for this entry, since you can comment an entry multiple times
{if rating:not_rated} This tag will conditionally display the code inside the tag if you have NOT already submitted a comment WITH rating for this entry, since you can comment an entry multiple times

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{exp:comment:form channel="products" entry_id="{entry_id}" dynamic="off" rating:enabled="yes"}
 
        {if rating:already_rated} You have already rated this entry{/if}
 
        {if rating:not_rated}
                {rating:fields}
                        <label>{rating:field_title}</label>
 
                        <select name="{rating:form_name}">
                                <option value="1">1</option>
                                <option value="2">2</option>
                                <option value="3">3</option>
                                <option value="4">4</option>
                                <option value="5">5</option>
                        </select>
                {/rating:fields}
 
                {!-- YOU CAN STILL HARDCODE THE form input name, for example: <select name="rating[default]"> --}
        {/if}
 
        <label>Review</label>
        <textarea name="comment" cols="70" rows="2"></textarea> <br />
 
        <input type="submit" value="Submit Comment">
 
{/exp:comment:form}

Support

Having problems setting up and/or using Channel Ratings? Support is offered from 10am to 4pm EST weekdays. Send us an email at help@eeharbor.com and we will respond as quickly as we can.