Getting Started

Installation

Download and install the RatingWP WordPress plugin from the WordPress.org plugin repository on your website.

Setup

Go to the RatingWP menu and click on Forms

Forms

Click to Add New form

Add and configure critiera to the form and click Save Changes. You can drag and drop the critiera to change the order.

Add Numeric Critiera

LabelThe label displayed for the criteria in the form
ValueMaximum value used when calculating rating score
Is ascendingThe score is calculated based on the numeric value selected between the min and max range.
If is ascending, max = highest possible value.
If not ascending, min = highest possible value.

Examples for numeric value selected = 20, min = 0, max = 100 and 60 is selected.
If ascending, the score = 20 * (60/100) = 12.
If not ascending, the score = 20 * ( 1 – 60/100 ) = 8
MinThe minimum numeric value that can be selected
MaxThe maximum numeric value that can be selected
DefaultThe default numeric value selected
DisplayThe criteria can be displayed as a numeric range slider input or a numeric input.

Add Lookup Critiera

LabelThe label displayed for the criteria in the form
ValueMaximum value used when calculating rating score
OptionsAdd lookup options that can be selected. The percentage value deterimines the score for the selected option. For example, if the maximum value = 20 and the percentage value for the selected option = .5, the score = 10.
DisplayThe criteria can be displayed as a select dropdown or radio buttons.

Add Star Rating Criteria

If your form only contains a single star rating critera, no submit button is shown and the form will submit as soon as a star is selected.

LabelThe label displayed for the criteria in the form
ValueMaximum value used when calculating rating score
Out OfHow many stars is the rating out of? E.g. out of 5. If the maximum value = 20, the star rating is out of 5 and 4 stars are selected, the score is 20 * (4/5) = 16.

Plugin Settings

The following General settings are available:

LabelChoose methods to check for duplicate form entry. This applies to guests / anonymous users only. Logged in users cannot rate the same subject and form more than once.
StringsYou can customise some of the default messages
StylesSelect a primary color which will be used as default in the Gutenberg blocks.

How Ratings are Calculated

Overall subject ratings are aggregatred and then averaged.

Here’s an example of how a rating score is calculated for a single subject rating form submission.

Example Form Criteria

Criteria IDTypeSelected
1Star RatingOut of: 5
Value: 20
2Star RatingOut of: 5
Value: 15
3LookupValue: 30
Options:
Option 1 with value percentage 50%
Option 2 with value percentage 75%
Option 3 with value percentage 100%
4NumericValue: 20
Is Ascending: Checked
Min: 0
Max: 100
5NumericValue: 20
Is Ascending: Unchecked
Min: 10
Max: 50

Example Form Entry Submission

Criteria ID SelectionFormulaCalculated ValueMaximum Value
15 stars20 * ( 5 / 5)2020
24 stars15 * ( 4 / 5 )1215
3Option 230 * 75%22.530
46020 * ( ( 60 – 0 ) / ( 100 – 0 ) )1520
52020 * ( 1 – ( ( 20 – 10) / (50 – 10) ) )1520

The calculated rating score is the total calculated value / total maximum value = 84.5 / 105 = 80.4.

Display a Form

Add the Rating Form Guternberb block to a post to display a rating form for a subject.

Now you will need to configure the block settings.

Form SettingsSelect the form
Subject DetailsUse current post as subject OR specify type as Post, Taxonomy or User.
For post subject types, you will need to specify which post type and post to rate.
For taxonomy tyoes, you will need to specify which taxonomy and term to rate.
For user types, you will need to specify which user to rate.
StylesSet the star rating criteria colors if criteria exists

Display a Rating Summary

Add a Rating Summary Gutenberg block to a post to dispay a rating summary for a subject. Then configure the block settings.

Form SettingsSelect the form
Subject DetailsUse current post as subject OR specify type as Post, Taxonomy or User.
For post subject types, you will need to specify which post type and post to rate.
For taxonomy tyoes, you will need to specify which taxonomy and term to rate.
For user types, you will need to specify which user to rate.
StylesChoose a rating summary layout: overall or details.
The overall layout displays an aggregate rating across all criteria in the form whereas the details layout will display each an aggregate ratig for each criteria .

For the overall layout, you can change the text align (left, center or right) and the header used (H1, H2 or H3).

You can display aggregate ratings as a score, star ratig or percentage.
For star ratings, you can change the primary color.

Display a List Table of Ratings

Add a Rating List Table Gutenberg block to a post to dispay subject ratings sorted by highest rated. Then configure the block settings.

Form SettingsSelect the form
Subject DetailsChoose the subject type as Post, Taxonomy or User.
For post subject types, you will also need to specify the post type.
For taxonomy tyoes, you will also need to specify the taxonomy.
StylesYou can change the default table style similar to the Table Gutenberg block with stripes.

You can display aggregate ratings as a score, star ratig or percentage.
For star ratings, you can change the primary color.

There’s some additional table settings allowing you have fixed width table cells, show a header row and show a ranking column.

View Submissions in WP-Admin

All form submissions can be viewed in the WP-admin under the Submissions plugin menu. You can also delete submissions.