Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/surveywp/kk-star-ratings

kk Star Ratings wordpress plugin
https://github.com/surveywp/kk-star-ratings

google-rich-snippets serp star-ratings structured-data votings wordpress-plugin

Last synced: 2 months ago
JSON representation

kk Star Ratings wordpress plugin

Lists

README

        

# kk Star Ratings - A WordPress Plugin

![icon-plugin-installs]
![icon-plugin-downloads-per-day]
![icon-plugin-downloads]
![icon-wp-rating]

![icon-plugin-version]
![icon-wp-version]
![icon-wp-tested]
![icon-php-version]
[![License][icon-license]](LICENSE.txt)

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 v5.

## **Table of contents**

- [Features](#features)
- [Installation](#installation)
- [Auto](#auto)
- [Manual](#manual)
- [FAQs](#faqs)
- [Changelog](#changelog)
- [i18n](#i18n)
- [Testing](#testing)
- [Contributing](#contributing)
- [Security](#security)
- [Credits](#credits)
- [Attribution](#attribution)
- [License](#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 amount of 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.
1. Upload/move the folder `kk-star-ratings` to the `wp-content/plugins` directory.
1. Activate the plugin via the wordpress plugins dashboard page.
1. 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 version of this plugin prior to v5. Is it safe for me to update?

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

> I found a bug or want to contribute.

The source of this plugin is located at [Github](https://github.com/kamalkhan/kk-star-ratings). Feel free to post an issue or submit a pull request.

## Changelog

Please see the [CHANGELOG](CHANGELOG.md) for more information on what has changed.

[Version 4.x](.github/CHANGELOG-v4.md) has been _archived_ as of July 2021.

[Version 3.x](.github/CHANGELOG-v3.md) has been _archived_ as of October 2019.

[Version 2.x](.github/CHANGELOG-v2.md) has been _archived_ as of July 2019.

[Version 1.x](.github/CHANGELOG-v1.md) has been _archived_ as of March 2016.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) and [CONDUCT](.github/CONDUCT.md) for details.

## Security

If you discover any security related issues, please email `[email protected]` instead of using the issue tracker.

## Credits

- [Kamal Khan](https://github.com/kamalkhan)
- [All Contributors][link-contributors]

## Attribution

The [pull request template](.github/PR_TEMPLATE) and [issue template](.github/ISSUE_TEMPLATE) have been adapted from the [thephpleague's skeleton package](https://github.com/thephpleague/skeleton).

## License

The GPLv2 or later license. Please see the [License File](LICENSE.txt) for more information.

[icon-wp-version]: https://img.shields.io/wordpress/plugin/wp-version/kk-star-ratings.svg
[icon-wp-tested]: https://img.shields.io/wordpress/plugin/tested/kk-star-ratings.svg
[icon-wp-rating]: https://img.shields.io/wordpress/plugin/rating/kk-star-ratings.svg

[icon-plugin-downloads-per-day]: https://img.shields.io/wordpress/plugin/dd/kk-star-ratings.svg
[icon-plugin-downloads]: https://img.shields.io/wordpress/plugin/dt/kk-star-ratings.svg
[icon-plugin-installs]: https://img.shields.io/wordpress/plugin/installs/kk-star-ratings.svg
[icon-plugin-version]: https://img.shields.io/wordpress/plugin/v/kk-star-ratings.svg

[icon-php-version]: https://img.shields.io/wordpress/plugin/required-php/kk-star-ratings

[icon-travis-status]: https://img.shields.io/travis/kamalkhan/kk-star-ratings.svg
[link-travis-status]: https://travis-ci.org/kamalkhan/kk-star-ratings

[icon-packagist-downloads]: https://img.shields.io/packagist/dt/bhittani/kk-star-ratings.svg
[link-packagist-downloads]: https://packagist.org/packages/bhittani/kk-star-ratings

[icon-license]: https://img.shields.io/badge/License-GPL%20v2-blue.svg

[link-composer]: https://getcomposer.org

[link-contributors]: https://github.com/kamalkhan/kk-star-ratings/contributors