Documentation

Documentation

1.Getting Started #

Rating Form uses the current post ID for voting, you can see it as a parent. There are few parents that can be used like the post_id:

Parent Shortcode attribute
post types (like: post, page or custom post type) post_id (auto gets current ID)
comment comment_id (auto gets current ID)
categories or taxonomies term_id (needs to be defined)

These parents can be separated as in multiple forms through shortcode attribute custom_id.

All the post types are stored in the same place, in the wp_posts database table, meaning the post id that is being used in Rating Form is unique. More information about post types.
Woocommerce, bbPress or any other plugin that uses a (custom) post type should work without any problem 🙂

List of available and useful:

Do you need further help or have a question? Contact me through support page on CodeCanyon.

Did you find this documentation useful?
  • 3.6/5
  • 54 ratings
54 ratingsX
Very bad! Bad Hmmm Oke Good!
18.5% 13% 7.4% 14.8% 46.3%

1.1.Installation #

There are two ways to install a plugin. Through WordPress Dashboard or FTP.

WordPress Dashboard

  1. Download the following file named rating-form.zip from CodeCanyon
  2. Navigate to Plugins > Add New
  3. Click on Upload Plugin at the top of the page
  4. Select file rating-form.zip
  5. Click Install Now
  6. Activate plugin after installation or on page Plugins

FTP

  1. Download and unpack ZIP file named rating-form.zip from CodeCanyon
  2. Open FTP and navigate to /wp-content/plugins/
  3. Upload directory named rating-form
  4. Activate plugin on page Plugins

1.2.Updating #

When a new update comes out, make sure you read the changelog on the bottom of the plugin’s page at codecanyon. If you decide to update the safest way is to update through FTP.

  1. Open FTP and navigate to /wp-content/plugins/rating-form/
  2. Overwrite the plugin files with the ones that you re-downloaded from codecanyon.
    This will not remove any data of Rating Form! Unless you delete this plugin through Dashboard.

2.myCRED #

Rating Form is compatible with myCRED 1.6 or above.
Click here for step by step explanation on myCRED.

3.bbPress #

How to use a Rating Form inside bbPress Replies?

You just need to insert the rating form shortcode after or before a reply content, Rating Form will detect automatically the current comment id.
Example code ( Change { } to [ ] ):

If you are getting the same rating result on all replies. You can try to use a function of bbPress that gets the current reply ID. Adjust the shortcode as followed:

Now we are telling this Rating Form with id 1 that the parent (post) ID is the current reply ID.
Because reply is a (custom) post type which is stored in the same place as any other post types (like post), so we are voting a unique post ID.

4.WPML #

A recent version of WPML (or above) is recommended and the String Translation add-on.

What is translatable?
You can translate strings: menu, pages, titles, widget and custom form messages in Rating Form, expect the plugin name 🙂

Custom Messages
In order to translate messages: success, rated, login, limit and edit rating. You will need to enable option "WPML Translate" in block "Extra's". This option is added because to avoid unwanted string translations of custom messages on new created rating forms.

How can I know if a title, custom message or shortcode attributes are already translated?
Translated titles and custom messages are shown with a flag and a string of the current language (default is English).
Preview (titles):
rf-title-translated-msg
Preview (custom message):
rf-msg-success-translated
Or you can go to page of WPML > String Translation.

Shortcode attributes: after_content and before_content
Same behaviour as above, option "WPML Translate" needs to enabled to translated shortcode attributes: after_content and before_content.