CommentArray::stars()

Get an average of all star ratings for all comments in this CommentsArray

Usage

// basic usage
$int = $commentArray->stars();

// usage with all arguments
$int = $commentArray->stars(bool $allowPartial = true, bool $getCount = false);

Arguments

NameType(s)Description
$allowPartial (optional)bool

Allow partial stars? If true, returns a float. If false, returns int.

$getCount (optional)bool

If true, this method returns an array(stars, count) where count is number of ratings.

Return value

int float false array

Returns false for stars value if no ratings yet.


CommentArray methods and properties

API reference based on ProcessWire core version 3.0.251