Shortcodes
rating_form
Display a Rating Form.
| Attribute | Description | Default | Value |
| id | Define rating form by ID | 1 | Number |
| post_id | Gets automatically the post id or add one manually | auto | Number |
| comment_id | Gets automatically the comment id or add one manually | auto | Number |
| custom_id | Define a unique ID for multiple rating forms on same post / page Allowed characters: letters, numbers, dash - or underscore _ | Empty | Text |
| term_id | Define term ID of categories or taxonomies | 0 | Number |
| user_id | Define user by ID | 0 | Number |
| title | Show / Hide titles (tooltip text) | false | Boolean |
| score | Show / Hide average ratings | true | Boolean |
| total | Show / Hide total ratings | true | Boolean |
| stats | Show / Hide rating statics | true | Boolean |
| user_stats | Show / Hide user stats after rating statics | false | Boolean |
| tooltip | Turn tooltip into static title if set to false | true | Boolean |
| result | Display rating result (You cannot rate) | false | Boolean |
| before_content | Add HTML / Content before a rating form | Empty | HTML / Text |
| after_content | Add HTML / Content after a rating form | Empty | HTML / Text |
| rates | Change text ratings. Separate the singular term with a plural term or use one term | rating,ratings | Text |
| txt_score | Change score format %1$s = Average rating of maximum rating %2$s = Maximum rating Example: 4.4 out of 5 | %1$s/%2$s | HTML / Text |
Shortcode Example
rating_form_top_rating_results
Display top ratings of different result type (see attribute type).
| Attribute | Description | Default | Value |
| form_id | Get style and settings from a Rating Form by ID | 1 | Number |
| post_id | Get results of a specific post / page ID | 0 | Number |
| before_title | Add HTML / Content before title | HTML / Text | |
| title | Change title | Top 5 Ratings | Text |
| after_title | Add HTML / Content after title | HTML / Text | |
| limit | Number of posts | 5 | Number |
| content_length | Shorten post content length by words | 10 | Number |
| content_active | Show / Hide post content | false | Boolean |
| image_size | Size of the featured image of a post in pixels | 48 | Number |
| image_active | Show / Hide featured image | false | Boolean |
| time | Set time of given time field | 0 | Number |
| time_field | Choice of fields: hour, day, week, month Example: [time="1" time_field="day"] Check post results of 1 day old | Empty | Text / Choice |
| type | Out of which type would you like to see the results? Choices: - post_pages - comments - taxonomies (for categories, tags etc.) - users | post_pages | Text |
| post_type | Display by selected multiple (custom) post types | post,page | Array |
| taxonomy | Filter by one or more taxonomies and/or terms within these taxomony. Seperate taxomony by | (vertical bar) Add terms by using : (colon) Add relation between terms through hyphen like -AND / -OR AND: every term in the array must be available OR (default behaviour): at least one of the term must be availableExample shortcode attribute: taxomony="computer-AND:hp,lenovo|laptop" | Empty | Text |
| before_content | Add HTML / Content before top results | Empty | HTML / Text |
| after_content | Add HTML / Content after top results | Empty | HTML / Text |
| class | Add custom CSS class | Empty | Text |
Shortcode Example
rating_form_total
Display total average rating result of multiple rating forms that uses custom_id.
| Attribute | Description | Default | Value |
| id | Get same style and settings from a Rating Form by ID | 0 | Number |
| post_id | Gets automatically the post id or add one manually | auto | Number |
| comment_id | Gets automatically the comment id or add one manually | auto | Number |
| custom_id | Display average rating result of a custom_id or multiple custom id's Example multiple: {rating_form_total custom_id="computer,laptop,mobile"} Example: {rating_form_total custom_id="laptop"} Change { } to [ ] | Empty | Text |
| term_id | Get average total result of a given term ID term_id are ID's for category, tags and taxonomy | 0 | Number |
| round | Set decimal of total average rounding | 1 | Number |
| live | Load total average result through ajax on load Useful for cache plugins | false | Boolean |
| type | Two type of total results. tud = Thumps Up / Down alike forms star = Stars alike forms | star | Text / Choice |
| type_count | Display specific average result in percentage or real numbers. Choice of: count, percentage Example: {rating_form_total type_count="percentage"} | count | Text |
| text | Two default text Type 'star' (default): %1$s average based on %2$s ratings Type 'tud': Up: %1$s Down: %3$s based on %2$s ratings %1$s = average rating or total Up ratings depends on type %2$s = total ratings %3$s = total Down Ratings | See description | HTML / Text |
Shortcode type 'star' example
3.8 average based on 109 ratings
Shortcode type 'tud' example
Up: 115 Down: 31 based on 146 ratings
rating_form_results
Display rating result for each star.
| Attribute | Description | Default | Value |
| id | Get settings of a rating form by ID | 1 | Number |
| post_id | Gets automatically the post id or add one manually | auto | Number |
| comment_id | Gets automatically the comment id or add one manually | auto | Number |
| custom_id | Define a unique ID for multiple rating forms on same post / page Allowed characters: letters, numbers, dash - or underscore _ | Empty | Text |
| term_id | Define term ID of categories or taxonomies | 0 | Number |
| class | Add custom CSS class | Empty | Text |
| layout_height | Change layout (block) height | 15px | Text |
| layout_width | Change layout (block) width | 100px | Text |
| layout_color | Change layout color (grey) | #dddddd | Text |
| fill_color | Change inner / fill color (yellow) | #ffd700 | Text |
| type_stars | Choice of types: stars, titles stars = 5 stars titles = Good! | stars | Text / Choice |
| type_count | Choice of types: count, percentage | count | Text / Choice |
| show_count | Show / Hide count | true | Boolean |
| live | Update results after rating or not To make this happen, select option in settings: Update rating_form_results after rating | true | Boolean |
| txt_stars | Change text 5 stars, 4 stars etc. %s = Number of stars | %s stars | HTML / Text |
| txt_count | Change text count %s = count (540) or percentage (78.5%) | %s | HTML / Text |
Shortcode Example
| 5 stars | 187 | |
| 4 stars | 33 | |
| 3 stars | 56 | |
| 2 stars | 37 | |
| 1 stars | 33 |