Channel Ratings Documentation

Rating - Top Channel Entries Tag

{exp:channel_ratings:top_entries}

Parameters

Parameter Description
channel Limit the list by a specific channel.
channel_id Limit the list by a specific Channel ID (faster).
custom_fields Here you can specify which custom fields to grab from you channel entries. To specify multiple fields, separate fields with the pipe character.
status Limit entries by their status. To specify multiple status, separate status with the pipe character.
include_review Include comment reviews in stats.
collection Limit by rating collection.
precision This parameter allows you to specify the number of decimals to round fractions on numerical rating fields for averages. For example, a value of 1 would give you a result like this for a rating value: 4.5. Default precision is "2".
thousands This parameter allows you to specify which character to use to separate groups of thousands in numeric rating fields. For example, a value of , would parse 10000 as 10,000. Default is , (comma). Default is ",".
fractions This parameter allows you to specify which character to indicate fractions in numeric ratings. (Decimals). Default is ".".
scale By default, Channel Ratings assumes your rating scale is 5. As in, your numerical ratings are out of 5 (ex: 1 out of 5 stars, 2 out of 5 stars, etc). You can however, change the scale to be out of “10” by specifying the scale parameter. When you specify this, the stars variable pairs will switch from the default of 5 graphic images to 10 when placed around your numerical rating value. Default is "5".
theme Since you can have your own custom themes, this parameter allows you to specify which theme to use. Default is "stars".
limit This parameter limits the number of items on any given page. The limit will default to 30 entries if a value is not specified. Default is "30".
backspace Backspacing removes characters (including spaces and line breaks) from the last iteration of the loop.
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.

Variables

Variable Description
{rating:entry_id} The entry ID
{rating:entry_title} The entries title
{rating:entry_date} The entry date For date variable info see: http://expressionengine.com/user_guide/templates/date_variable_formatting.html
{rating:CUSTOM_FIELD} Replace CUSTOM_FIELD with the field you want. The ones you specified in the custom_fields=”” parameter
{rating:channel_id} The channel ID of the entry.
{rating:channel_name} The channel short name of the entry.
{rating:channel_title} The channel title (label) of the entry
{rating:channel_url} The channel URL of the entry, as specified in the channel preferences
{rating:channel_search_result_url} The channel search results URL of the entry, as specified in the channel preferences
{rating:channel_comment_url} The channel comment URL of the entry, as specified in the channel preferences.
{rating:overall:avg} This variable outputs the overall average rating value for all fields.
{rating:overall:total} This variable outputs the total amount of ratings submitted.
{rating:overall:sum} This variable outputs the total cumulative value/score of all ratings submitted.
{rating:overall:latest_date} The date/time of the latest rating submission For date variable info see: http://expressionengine.com/user_guide/templates/date_variable_formatting.html
{rating:overall:stars} This variable outputs “star” images to construct a graphical representation of the overall average rating value.
{rating:count} The “count” out of the current item being displayed. If five items are being displayed, then for the fourth item the count variable would have a value of “4”.
{rating:total_entries} The total number of entries being displayed.

Conditionals

Conditional Description
{if rating:no_entries} This tag will conditionally display the code inside the tag if there are no items to display.

Example

1
2
3
4
5
6
7
8
9
10
{exp:channel_ratings:top_entries custom_fields="body|extended"}
 
                <h2>{rating:entry_title}</h2>
 
                <p>{rating:body}</p>
                <p>{rating:extended}</p>
 
                Rating: OVERALL: {rating:overall:stars} ({rating:overall:avg} of 5)
 
{/exp:channel_ratings:top_entries}

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.