gdrts_aggregate()->comments_by_post()

gdrts_aggregate()->comments_by_post(
        $post_id, $args = array())

Description

Calculate aggregated rating for all comments belonging to a specified post by ID. Array $args contains additional settings. This function return object with the calculated aggregated rating containing rating and votes (and also minimal and maximal rating and posts for individual items in the calculation.

Parameters

• $post_id: valid user ID
• $args: array with additional settings

$args array

• comment_type: name of the comment type, default: ‘comment’
• method: name of the rating method
• series: name of the series for rating methods that have series

Examples

Get aggregated stars rating for all comments belonging to post with ID 14:

<?php $_aggreation = gdrts_aggregate()->comments_by_post(
        14, array('method' => 'like-this')); ?>

When you run this, you will get the object with results like this:

stdClass Object
(
    [rating] => 3
    [rating_min] => 1.00
    [rating_max] => 4.00
    [votes] => 8
    [votes_average] => 2
    [votes_min] => 1
    [votes_max] => 3
    [items] => 4
)

This is the array with the results for the Like This rating, showing average rating of 3 for the comments belonging to this post.