kk Star Ratings - A WordPress Plugin

kk Star Ratings allows blog visitors to involve and interact more effectively with your website by rating posts.

This plugin has been renewed from the ground up as of v3 covered by unit tests.

Table of contents

• Features
• Installation
  • Auto
  • Manual
• FAQs
• Changelog
• i18n
• Testing
• Contributing
• Security
• Credits
• Attribution
• License

Features

kk Star Ratings is a widely used star rating plugin for wordpress. Here are some highlighted features:

• User defined amount of star ratings (5 as default) in your posts, pages and publicly accesible custom post types.

• Structured data supporting google rich snippets showing the star ratings in search results which has the potential to drive more traffic to your website.

• Widespread coverage of custom hooks.

• Full control via options page. You can,

  • Enable or disable globally.

  • Disable star ratings in posts that belong to certain categories.

  • Choose where to show the star ratings. It can be on the homepage, in archives, in posts, in pages and/or in custom post types.

  • Control the structured data schema and type.

  • Restrict votings per unique ip.

  • Allow voting in archives.

  • Allow guests to vote.

  • Customize position within the post content.

  • Adjust the number of stars.

  • Adjust the amount of stars.

  • Adjust the colors of the stars.

• And much more...

Installation

Auto

1. Navigate to your wordpress plugins dashboard page.
2. Upload the plugin zip file.
3. Activate the plugin via the wordpress plugins dashboard page.
4. Adjust the plugin options under the kk Star Ratings menu in wp-admin.

Manual

1. Extract the plugin zip file.
2. Upload/move the folder kk-star-ratings to the wp-content/plugins directory.
3. Activate the plugin via the wordpress plugins dashboard page.
4. Adjust the plugin options under the kk Star Ratings menu in wp-admin.

FAQs

What should I do if the structured data is not picked by search result pages?

Please have patience as we have no control over how google or any search engine indexes your pages. It might take some days or even weeks for the robots to crawl the ratings.

I have been using a verion of this plugin prior to v3. Is it safe for me to update?

All previous ratings and options will be preserved. However, since v3 has been renewed from scratch, we do not support downgrading to v2 after upgrading to v3.

I found a bug or want to contribute.

The source of this plugin is located at Github. Feel free to post an issue or submit a pull request.

Changelog

Please see the CHANGELOG for more information on what has changed.

Version 2.x has been archived as of July 2019.

Version 1.x has been archived as of March 2016.

i18n

npm install
npm run i18n

or

yarn
yarn i18n

Testing

You may clone this repository for development and test purposes.

git clone https://github.com/kamalkhan/kk-star-ratings

cd kk-star-ratings

composer install

composer install-test-suite

composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email shout@bhittani.com instead of using the issue tracker.

Credits

• Kamal Khan
• All Contributors

Attribution

The pull request template and issue template have been adapted from the thephpleague's skeleton package.

License

The GPLv2 or later license. Please see the License File for more information.