Jump to content

Page Ratings

Marvin Scharle

Recommended Posts

Hi everybody,

I'd like to share with you another new module. It helps you to manage user ratings for pages in a very simple way.

You can add a user rating to a certain page with a line of code:


If the user is logged in, the module remembers which page the user has rated for. For non-logged-in visitors, the module stores the pages, the user has rated, in the session. 

You can get a page's rating and its total amount of votes in a similar way:

$page->ratings->average;      // => 3.2
$page->ratings->count;        // => 5

For more information about this module, please check out its GitHub repository.

You can check out a working version of the module here: http://curium-cte.lightningpw.com

Edit: The module is now available in the ProcessWire modules directory.

Update: Ratings has been updated to version 1.1, including a new, simpler API accessor. 

As always - please comment for bugs or feature wishes.

Thanks in advance,


Edited by Marvin Scharle
  • Like 20
Link to comment
Share on other sites

Hi Nico,

nice question. I was unclear about this. 

Basically, the ratings are saved to the database, but the information about which pages the user has rated is stored in the session for guests. 

This is just how the module handles preventing guests rating the same page again after a short period of time. 

  • Like 1
Link to comment
Share on other sites

Hello again!

We've just updated Ratings to Version 1.1, which includes a simpler, more unified API.

You can access all API methods via the ratings property.


$page->ratings->average;   // => 4.4
$page->ratings->count;     // => 12

The changes should appear soon in the ProcessWire modules directory. Please check out our GitHub repository for more details.

  • Like 5
Link to comment
Share on other sites

  • 1 month later...

I am playing around with your module, using your example here. However I keep getting a "Use of undefined constant ​ - assumed" in my functions file at the closing line when including the "renderRating" function. I can't figure out. I am sure its user error. Any help is appreciated. Great module, thanks for sharing it.

Link to comment
Share on other sites

  • 2 weeks later...

This is up to you. The module doesn't generate markup so you could just trigger the PHP call when a user clicks on a star.

Theoretical, you fire a Javascript event when the users clicks the star together with the value (1,2,3,4,5) of the star. Then your code adds this rating.

Link to comment
Share on other sites

  • 2 months later...

Thank guys for this module - it was great to quickly set up a ratings system.

A couple of thoughts though.

  1. I am not sure why it needs to be an autoload module - I'd rather you simply load it manually in a template file when you want to use it.
  2. I am not sure why it isn't simply a custom fieldtype that can be added to templates as needed - the way you have done it seems to work just fine, but the one issue I am having is that it can't be used as easily in all situations - for example, you can't select "rating" as an option when configuring a custom view with ListerPro. I am sure there are also other situations where it would be preferable to be a fieldtype, but maybe there are advantages to the approach you have taken that I am not thinking about.
  3. Of course if #2 is implemented, then #1 is no longer an issue :)

Any chance you'd consider a bit of a rewrite to make it a fieldtype? if not, please let me know and I'll put something together myself - just trying to avoid duplicate modules that do the same thing :)

Thanks for considering.

  • Like 3
Link to comment
Share on other sites

  • 5 months later...

I am also looking for this as a fieldtype, because I have a Repeater field for different products with ratings.

Also I want to integrate this with the comments fieldtype.

How would I do that?

I found https://processwire.com/talk/topic/10107-fieldtypestarrating/ as an alternative, which is a fieldtype, but it doesn´t handle floats (average ratings) and has no option to use the star rating on the frontend (rating and saving to database).

  • Like 2
Link to comment
Share on other sites

  • 1 month later...

I'd like this as fieldtype also.

Or does anyone has a hint how to place the ratingform/-field at the pageedit form in the be. Would like to integrate user ratings, e.g. in that way the user only sees his own rating to edit.

I haven't played with it myself yet, but does this do what you want?


Link to comment
Share on other sites

  • 3 months later...

Nice module!

I would love to see a feature to allow adding unlimited votes using the api without binding to a user. So for example to put a review form on the site where people (not users!) could vote. Their submitted votes would be processed then using the add() method. Currently it doesn't work because once you use add(), you cannot add another vote with the same user.

Commenting out the body of the current() method in the module seems to work, but an official solution would be nice.

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for creating a new measurement object from the sum or difference between two other objects. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.
      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.

      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      ProcessWire module directory
    • By Robin S
      Repeater Easy Sort
      Adds a compact "easy-sort" mode to Repeater and Repeater Matrix, making those fields easier to sort when there are a large number of items.
      The module also enhances Repeater Matrix by allowing a colour to be set for each matrix type. This colour is used in the item headers and in the "add new" links, to help visually distinguish different matrix types in the inputfield.
      A Repeater field

      A Repeater Matrix field with custom header colours

      Easy-sort mode
      Each Repeater/Matrix item gets an double-arrow icon in the item header. Click this icon to enter easy-sort mode.
      While in easy-sort mode:
      The items will reduce in width so that more items can be shown on the screen at once. The minimum width is configurable in the field settings. Any items that were in an open state are collapsed, but when you exit easy-sort mode the previously open items will be reopened. You can drag an item left/right/up/down to sort it within the items. The item that you clicked the icon for is shown with a black background. This makes it easier to find the item you want to move in easy-sort mode. You can click an item header to open the item. An "Exit easy-sort mode" button appears at the bottom of the inputfield. Configuration
      In the field settings for Repeater and Repeater Matrix fields you can define a minimum width in pixels for items in easy-sort mode. While in easy-sort mode the items will be sized to neatly fill the available width on any screen size but will never be narrower than the width you set here.
      In the field settings for Repeater Matrix you can define a custom header colour for each matrix type using an HTML "color" type input. The default colour for this type of input is black, so when black is selected in the input it means that no custom colour will be applied to the header.
      The easy-sort mode is only possible on Repeater/Matrix fields that do not use the "item depth" option.
  • Create New...