CommentStars class

Class CommentStars

Handles rendering of star ratings for comments. Additional code in comments.js and comments.css accompanies this.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the CommentStars class also inherits all the methods and properties of: WireData and Wire.

Common
Properties

Common

Name	Return	Summary
CommentStars::render() CommentStars::render() CommentStars::render($stars = 0, bool $allowInput = false)	`string`	Render stars
CommentStars::renderCount() CommentStars::renderCount(int $count) CommentStars::renderCount(int $count, $stars = 0, string $schema = '')	`string`	Render a count of ratings
CommentStars::setDefault() CommentStars::setDefault($key, $value) CommentStars::setDefault($key, $value)	None	Change one of the defaults (see $defaults)

Properties

Name	Return	Summary
CommentStars::countClass	`string`	Class used for the renderCount() method
CommentStars::countLabelPlural	`string`	Plural count label
CommentStars::countLabelSingular	`string`	Single count label
CommentStars::detailsLabel	`string`	Star details label
CommentStars::numStars	`int`	Max number of stars
CommentStars::star	`string`	Default star output (can be overridden with HTML)
CommentStars::starClass	`string`	Class for stars whether on or off
CommentStars::starOff	`string`	Optionally use this star/HTML for OFF state
CommentStars::starOffClass	`string`	Class for inactive/off stars
CommentStars::starOn	`string`	Optionally use this star/HTML for ON state
CommentStars::starOnClass	`string`	Class for active/on stars
CommentStars::starPartialClass	`string`	Class for partial (half lit star)
CommentStars::unratedLabel	`string`	Unrated label
CommentStars::wrapClass	`string`	Wrapping element class, required for JS and CSS
CommentStars::wrapClassInput	`string`	Wrapping input element class, required for JS and CSS

Additional methods and properties

In addition to the methods and properties above, CommentStars also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.252