1. Table of content
  2. 1. Introduction
  3. 2. Install Plugin
  4. 3. Auto show rating front-end
  5. 4. Manual show rating front-end
  6. 5. Display widgets to front-end
  7. 6. Admin settings
  8. 7. Change Logs
  9. 8. Contact - support

Table of content

1. Introduction ( Introduce about this plugin)
2. Install Plugin  (How to install this plugin)
3. Auto display rating to front-end (Automatic show rating in front-end via setting in plugin admin)
4. Manual display rating to front-end  (Manual show rating in front-end via manual include code to template)
5. Display widgets to front-end  (How to show widget to front-end)
6. Admin settings  (Plugins admin settings)
7. Change Logs  (Plugins change logs)
8. Contact - support (About plugin author and support information)
 
 

 In 3. and 4. , you can use one of two methods to display rating box on front-end

3. Automatic: Quick, easy but don't custom. This method can only display rating box one of two place are before or after the content. Recommend if you are amateur wordpress.

4.  Manual custom: Display rating box to any place you want on front-end. Recommend if you have knowledge about wordpress themes development.

Note: Don't use both methods at a time. Please use only one of two methods. Thanks you

1. Introduction - Top

Wordpress Advance Rating System (WPARS)


Thank you for purchased my plugin.

Wordpress advanced rating system (WPARS) is good rating system for wordpress. WPARS will help you set up rating system for posts, pages and all custom post type in your wordpress website.

WPARS support many styles with custom shapes, custom colors and custom sizes which you can settings them in your wordpress admin page.

WPARS use ajax dynamic loading data, so no need reload your url when rating processed.

WPARS support protect rating method to anti-spam rating and custom rating text template will display in your website.

And more, WPARS support WPARS statistics widgets. With this widget you can insert into the sidebars for display top ratings, top scores, top average statistics generated by the WPARS. In addition there are many options that you can set up in each widget as display thumbnail for widget with control width - height, auto trim title, control number post with display, sort post by average - raters - scores, filter posts by post, page, category, tag, custom post type, custom taxonomy.

WPARS will add a menu link in your wordpress admin page to settings rating system. With this link, you can setting rating shapes, rating colors, rating sizes, protect rating, rating template and widget template will display in your website.

Featured

Introduce video

Back to top

2. Install Plugin - Top

There are two methods to install plugin ( Please use one of two method)

Method 1: Upload .zip file from WordPress dashboard

Step 1: From wordpress admin page, go to menu Plugins > Add New > Upload, then Click Browse to choose file.
 
 
 
Step 2:  Browse to file wp-advanced-rating-system.zip archive on your hard drive computer, click Open
 
 
 
Step 3: Click Install Now
 
 
Step 4: Click Activate Plugin to activate wordpress advanced rating system plugin.
 
 
 

Method 2: Use FTP Upload

Step 1:  Using your FTP program, upload folder "wp-advanced-rating-system"  into the yourdomain/wp-content/plugins/ directory on your server. 
 
 
 
Step 2: Login to wordpress admin page, go to menu Plugins > Installed Plugins and find Wordpress Advanced Rating System in the list, Click Activate to activate it.
 
 
 
After Pugin activated, a menu WP Advanced Rating System will auto appear in left menu on wordpress admin page. This menu to settings for plugin.
 

Back to top

3. Auto show rating front-end - Top

This methods will auto add rating box before or after content. You do only 1 simple step:

Go to WP Advanced Rating System, in General settings TAB, Check to checkbox Auto display rating and choose position rating box will display. Position can be set  Above content (rating box will display before the content) or Bellow content (rating box will display after the content).

If don't check, rating post not show

If checked and choose position Above content, rating box will auto show in before the content.

If checked and choose position Bellow content, rating box will auto show in after the content

Back to top

4. Manual show rating front-end - Top

To use manual display rating box, you need do 2 steps:

Step 1:  Un-checked Auto display rating

Go to WP Advanced Rating System, in General settings TAB.

+ If Auto display rating box is checked, please Un-checked it and click Update Settings to save new settings.

+ If Auto display rating box is Un-checked, Ok, please go to step 2.

 

Step 2: Manual insert code to theme

Note: To do this step, please make sure after step 1, Auto display rating box is un-checked.

This step will need you manually insert code into themes to show rating box. 

The first, please read "A. Functions Introduce" to understand about functions you can use. Then, continue read "B. Use Functions to show rating box" to get code and insert to theme.

A. Functions introduce.

Wordpress Advanced Rating System provide 4 functions for you use to display rating box on front-end.
 
Before read details of 4 functions, please view two images:
 
Image 1: Rating Box
Rating box can be contain Rating Image or Rating text or both.
 
 
Image 2: Rating Info
 
 
Ok. Bellow is information 4 funtions:
 
Function 1: wpars_rating() .
<?php if(function_exists('wpars_rating')) { echo wpars_rating($status, $size); } ?>

This function will display rating box (show both rating image and rating text). 

Parameters:
+ $status : control rating enable or disable.
  Value: 0 , 1 or null.  Default value is null.
  If $status = 1 or $status = null, rating enable. If $status = 0, rating disable. 
+ $size : rating image size.
  Value: null or number range from 5 to 50.
 if $size = null, rating image size = Default image size settings in wordpress plugin admin page.
 
Function 2: wpars_rating_img() .
<?php if(function_exists('wpars_rating_img')) { echo wpars_rating_img($status, $size); } ?>

This function will display rating box (Show only rating image). 

Parameters:
+ $status : control rating enable or disable. 
  Value: 0 , 1 or null.  Default value is null.
  If $status = 1 or $status = null, rating enable. If $status = 0, rating disable. 
+ $size : rating image size.
  Value: null or number range from 5 to 50.
 if $size = null, rating image size = Default image size settings in wordpress plugin admin page.
 
Function 3: wpars_rating_text() .
<?php if(function_exists('wpars_rating_text')) { echo wpars_rating_text(); } ?>

This function will display rating box (show only rating text). This function no need parameter.

Function 4: wpars_get_rating() .
<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating($data); } ?>

This function will display rating info from parameter $data. Rating info can be Rating Average, Total raters, Total scores, Rating percent, Max Rating.

Parameters:

$data: control out put will display.
Value: Please set value is one of  'average', 'raters',  'scores', 'percent', 'max_rates'.
$data =  'average' : Show Rating Average.
$data =  'raters' : Show Total Raters.
$data =  'scores' : Show Total Scores.
$data =  'percent' : Show Rating Percent
$data =  'max_rates' : Show Max Rating Score. 

B. Use Functions to show rating box.

To show rating box, you must  be manually insert code into wordpress loop in your themes.

What file you can insert code to show rating?

For show rating in front-end, you must open folder current theme using. ( yourdomain/wp-content/themes/current_theme_folder), then open file you want show post via a code editor program, insert code into wordpress loop and save file. Front-end will show rating.

Popular file you can insert code: home.php, index.php, single.php, archive.php, search.php, tag.php, category.php, type-{post-type}.php, taxonomy.php,.....

For more information please go to http://codex.wordpress.org/Template_Hierarchy .

What is wordpress loop?

A wordpress loop normal same bellow example:

<?php if (have_posts()) : ?>
  <?php while (have_posts()) : the_post(); ?>  
               <!-- Begin Wordpress Loop -->
                  <!-- Insert code in here ... -->

	               <!-- End Wordpress Loop -->
               <?php endwhile; ?>
    <?php endif; ?>
<?php if (have_posts()) : ?>
             

You can find more information about wordpress loop in http://codex.wordpress.org/The_Loop.

 

What code need you insert to theme?

Please choose list code bellow to use.

Note: Default rating size with get value from plugin general settings.

LIST CODE YOU CAN USE:

1. Display both rating image and rating text:

1.1. Enable rating, Default rating size:

<?php if(function_exists('wpars_rating')) { echo wpars_rating(); } ?>

OR 

<?php if(function_exists('wpars_rating')) { echo wpars_rating(1); } ?>

1.2. Disable rating, Default rating size:

<?php if(function_exists('wpars_rating')) { echo wpars_rating(0); } ?>

1.3. Enable rating, Custom rating size:

<?php if(function_exists('wpars_rating')) { echo wpars_rating(1,30); } ?>

  (30: Rating image size. Change it to you want.)

1.4. Disable rating, Custom rating size:

<?php if(function_exists('wpars_rating')) { echo wpars_rating(0, 30); } ?>

  (30: Rating image size. Change it to you want.)

2. Display only rating image:

2.1. Enable rating, Default rating size:

<?php if(function_exists('wpars_rating_img')) { echo wpars_rating_img(); } ?>

OR 

<?php if(function_exists('wpars_rating_img')) { echo wpars_rating_img(1); } ?>

2.2. Disable rating, Default rating size:

<?php if(function_exists('wpars_rating_img')) { echo wpars_rating_img(0); } ?>

2.3. Enable rating, Custom rating size:

<?php if(function_exists('wpars_rating_img')) { echo wpars_rating_img(1,30); } ?>

  (30: Rating image size. Change it to you want.)

2.4. Disable rating, Custom rating size:

<?php if(function_exists('wpars_rating_img')) { echo wpars_rating_img(0, 30); } ?>

  (30: Rating image size. Change it to you want.)

3. Display only rating text:

<?php if(function_exists('wpars_rating_text')) { echo wpars_rating_text(); } ?>

4. Display rating info:

4.1. Rating Average

<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('average'); } ?>

4.2. Total raters

<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('raters'); } ?>

4.3. Total scores

<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('scores'); } ?>

4.4. Rating percent

<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('percent'); } ?>

4.5. Max rating scores ( 5 or 10 )

<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('max_rates'); } ?>

EXAMPLE

Example 1: Display both rating image and rating text, rating enable, size =  default size.

Code use:

<?php if(function_exists('wpars_rating')) { echo wpars_rating(); } ?>
 

Insert to wordpress loop:

Result:

 

Example 2:  Display only rating image in above the content and display only rating text in bellow the content, rating image size  =  default size.

 

Code use:

<?php if(function_exists('wpars_rating_img')) { echo wpars_rating_img(); } ?>
AND
<?php if(function_exists('wpars_rating_text')) { echo wpars_rating_text(); } ?>

Insert to wordpress loop:

Result:

 

 

Example 3:  Display all rating info and display only rating text in above the content, display both rating image and rating text (rating enable and  rating image size  =  35) in bellow the content.

Code use:

 

<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('average'); } ?>
<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('raters'); } ?>
<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('scores'); } ?>
<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('percent'); } ?>
<?php if(function_exists('wpars_get_rating')) { echo wpars_get_rating('max_rates'); } ?>

AND 

<?php if(function_exists('wpars_rating_text')) { echo wpars_rating_text(); } ?>

AND 

<?php if(function_exists('wpars_rating')) { echo wpars_rating(1,35); } ?>

Insert to wordpress loop:

Result:

 

Back to top

5. Display widgets to front-end - Top

To display  widget in frond-end, please go to Appearance >> Widgets in wordpress admin page. This place  will show all available widgets you can use. When WPARS plugin activated, you will see widget WPARS statistics in here.

Please drag and drop WPARS statistics widget in Siderbar to show top post by rating in front-end. You can drag and drop many widgets.

Result:

Widgets config:

Back to top

6. Admin settings - Top

Go to WP Advanced Rating System in admin page to settings for plugin.

1. General settings

Auto display rating Check if you want show rating in front-end automatic
Max Rating Switch 5 or 10 scores
Default Size Set default size of shape
Rating Shapes Choose shape for rating display
Rating colors Choose color for rating display. Switch color for nice with your themes
Allow rating

Switch "Guest and members" or "Only Members".

Guest and members: Allow guest and members can rating.
Only Members: Only members can rating, guest can not rating.
Logged method

Switch "None" or "Cookie". Logged method when rating

 

None: none logged. 1 people can rating many numbers of times.
Cookie: (Recommend): 1 people only can rating one time for 1 post unless browser's cookie
is deleted or cookie expire. 
 

2. Rating Text Template settings

Config for rating text. 

Template No Rating Text will display when no rating for post.
Template Rating Text for normal rating (post has rating)
Template Rated Text will appear then has people rating and rating processed.
Template rating disable text will display when you set up post is disabled.
Template rating not allow If you set up Allow rating (in General setting) is "Only members" , guest will see this text. If members, text will display Template Rating
Template rating only text This text will display when you use function wpars_rating_text()

3. Rating Widget Template settings

In earch WPARS statistics widgets, you will config post order by. 

 

Template Top Average Display this template if you config widget sort post order by "Rating average"
Template Top Raters Display this template if you config widget sort post order by "Rating total raters"
Template Top Scores Display this template if you config widget sort post order by "Rating total scores"
Template Normal Sort Post  Display this template if you config widget sort post order by Post ID, Post title, Post date, Post comment, Post Random

 

Back to top

7. Change Logs - Top

5/5/2013: Version 1.0 Initial Release

Back to top

8. Contact - support - Top

Thank you for purchased this plugin.

If you want get support please contact with us. Please go to http://kuncode.com to get support information details.

Don't forget like and subscribe our social networks to recieve hot news from us.

Our Website | Facebook | Twitter | Google+

Thanks so much.

Back to top