With kk Star Ratings, you can allow your blog posts to be rated by your blog visitors. It also includes a widget which you can add to your sidebar to show the top rated post. There are some useful options you can set to customize this plugin. You can do all that after installing and activating the plugin and then visiting the Plugin Settings.
Version: 1.6
Author: Kamal Khan
Author URI: http://bhittani.com
License: GPLv2 or later
*/
// Make sure class does not already exist (Playing safe).
if(!class_exists('kk_Ratings') && !isset($kkratings) && !function_exists('kk_star_ratings') && !function_exists('kk_star_ratings_get')) :
// Declare and define the plugin class.
class kk_Ratings
{
// will contain id of plugin
private $plugin_id;
// js file
private $js_file;
// css file
private $css_file;
// Will be responsible for storing plugin options
private $options;
// Manual mode flag
private $manual_mode;
/** function/method
* Usage: defining the constructor (setting the plugin id and table prefix)
* Arg(2): string(alphanumeric, underscore, hyphen), string
* Return: void
*/
public function __construct($id)
{
// set plugin id
$this->plugin_id = $id;
// set js file
$this->js_file = '/js/kk-ratings.js';
// set css file
$this->css_file = '/css/kk-ratings.css';
// retrieve array of options
$this->options = $this->get_options();
// set manual mode to false
$this->manual_mode = false;
}
/** function/method
* Usage: return file path relative to current plugin directory
* Arg(1): string
* Return: string
*/
private function file_path($filepath)
{
return plugins_url($filepath, __FILE__);
}
/** function/method
* Usage: helper for hooking js script
* Arg(0): null
* Return: void
*/
public function js()
{
if (!is_admin())
{
$nonce = wp_create_nonce($this->plugin_id);
$params = array();
$params['nonce'] = $nonce; //for security
$params['path'] = $this->file_path('').'/';
$params['root'] = urlencode(ABSPATH);
$params['pos'] = $this->options['position'];
//wp_deregister_script('jquery');
//wp_register_script('jquery', ("http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"), false);
wp_enqueue_script('jquery');
wp_enqueue_script($this->plugin_id.'_js', $this->file_path($this->js_file), array('jquery') );
wp_localize_script($this->plugin_id.'_js', str_replace('-', '_', $this->plugin_id).'_settings', $params);
}
}
public function css($head)
{
echo "";
}
/** function/method
* Usage: return saved options
* Arg(0): null
* Return: array
*/
private function get_options($key=false)
{
// return saved options
$options = get_option($this->plugin_id);
if($key) return $options[$key];
return $options;
}
/** function/method
* Usage: update new options
* Arg(0): null
* Return: void
*/
private function update_options($options=false)
{
// update options
update_option($this->plugin_id, $options ? $options : $this->options);
}
public function activate()
{
//$this->options['legend'] = '[avg]([per]) [total] votes'; // [total]=total ratings, [avg]=average, [per]=percentage
//$this->update_options();
if(!count($this->options)) :
$this->options['enable'] = 1; // 1, 0
$this->options['clear'] = 0; // 1, 0
$this->options['show_in_home'] = 0; // 1, 0
$this->options['show_in_archives'] = 0; // 1, 0
$this->options['show_in_posts'] = 1; // 1, 0
$this->options['show_in_pages'] = 0; // 1, 0
$this->options['unique'] = 0; // 1, 0
$this->options['position'] = 'top-left'; // 'top-left', 'top-right', 'bottom-left', 'bottom-right'
$this->options['legend'] = '[avg]([per]) [total] votes'; // [total]=total ratings, [rating]=average, [per]=percentage
$this->options['init_msg'] = 'Be the first to rate it!'; // string
$this->options['column'] = 1; // 1, 0
$this->update_options();
endif;
if(!isset($this->options['column']))
{
$this->options['column'] = 1;
$this->update_options();
}
// add meta_key for avg. Required for backward compatibility
global $wpdb;
$table = $wpdb->prefix . 'postmeta';
$posts = $wpdb->get_results("SELECT a.ID, b.meta_key, b.meta_value FROM " . $wpdb->posts . " a, $table b WHERE a.ID=b.post_id AND (b.meta_key='_kk_ratings_ratings' OR b.meta_key='_kk_ratings_casts') ORDER BY a.ID ASC");
$wrap = array();
foreach ($posts as $post)
{
$wrap[$post->ID]['id'] = $post->ID;
$wrap[$post->ID][$post->meta_key] = $post->meta_value;
}
foreach($wrap as $p)
{
update_post_meta($p['id'], '_kk_ratings_avg', round($p['_kk_ratings_ratings']/$p['_kk_ratings_casts'],1));
}
}
public function admin_init()
{
register_setting($this->plugin_id.'_options', $this->plugin_id);
}
/** function/method
* Usage: helper for hooking (registering) the theme menu under settings
* Arg(0): null
* Return: void
*/
public function menu()
{
add_options_page('kk Star Ratings', 'kk Star Ratings', 'manage_options', $this->plugin_id.'_options', array(&$this, 'options_page'));
}
/** function/method
* Usage: show options/settings form page
* Arg(0): null
* Return: void
*/
public function options_page()
{
if (!current_user_can('manage_options'))
{
wp_die( __('You do not have sufficient permissions to access this page.') );
}
//FLUSH the ratings
if(!empty($_POST) && check_admin_referer('kkratings_flush','kkratings-flush-nonce'))
{
if(!strcmp($_POST['kkratings-flush-cfm'],'Yes'))
{
$postids = trim($_POST['kkratings_input']);
if(strcmp($postids,''))
{
$posts = explode(',', $postids);
$poststoflush = '';
foreach($posts as $key=>$val)
{
delete_post_meta($val, '_kk_ratings_ratings');
delete_post_meta($val, '_kk_ratings_casts');
delete_post_meta($val, '_kk_ratings_ips');
delete_post_meta($val, '_kk_ratings_avg');
}
echo 'Ratings for id(s) '.$postids.' have been FLUSHED Successfully
';
}
else
{
$allposts = get_posts('numberposts=-1&post_type=post&post_status=any');
foreach( $allposts as $postinfo)
{
delete_post_meta($postinfo->ID, '_kk_ratings_ratings');
delete_post_meta($postinfo->ID, '_kk_ratings_casts');
delete_post_meta($postinfo->ID, '_kk_ratings_ips');
delete_post_meta($postinfo->ID, '_kk_ratings_avg');
}
echo 'All ratings have been FLUSHED Successfully
';
}
}
if(!strcmp($_POST['kkratings-flush'],'Flush Ratings'))
{
$postids = trim(str_replace(' ', '',$_POST['kkratings_input']));
echo '';
}
}
//end
// get saved options
$options = $this->get_options();
include('admin/options.php');
}
public function init()
{
if(!is_admin() && $this->options['enable'])
{
add_filter('the_content', array(&$this, 'filter_content'));
add_filter('the_excerpt', array(&$this, 'filter_content'));
}
}
public function markup($id=false)
{
$markup = '
'.(!$id?get_the_ID():$id).'
'.$this->options['init_msg'].'
Thanks!
An error occurred!
';
$markup .= $this->options['clear']? '
' : '';
return $markup;
}
public function do_it_manually()
{
if(!is_admin() && $this->options['enable'])
{
if(
(($this->options['show_in_home']) && (is_front_page() || is_home()))
|| (($this->options['show_in_archives']) && (is_archive()))
)
return $this->markup();
else if(is_single() || is_page())
return $this->markup();
}
else
remove_shortcode('kkratings');
return '';
}
public function filter_content($content)
{
if(
(($this->options['show_in_home']) && (is_front_page() || is_home()))
|| (($this->options['show_in_archives']) && (is_archive()))
|| (($this->options['show_in_posts']) && (is_single()))
|| (($this->options['show_in_pages']) && (is_page()))
) :
remove_shortcode('kkratings');
$content = str_replace('[kkratings]', '', $content);
$markup = $this->markup();
switch($this->options['position'])
{
case 'bottom-left' :
case 'bottom-right' : return $content . $markup;
default : return $markup . $content;
}
endif;
return $content;
}
public function add_column($Columns)
{
if($this->options['column'])
$Columns['kk_star_ratings'] = 'Ratings';
return $Columns;
}
function add_row($Columns, $id)
{
if($this->options['column']) :
$raw = (get_post_meta($id, '_kk_ratings_ratings', true)?get_post_meta($id, '_kk_ratings_ratings', true):0);
$avg = ''.(get_post_meta($id, '_kk_ratings_avg', true)?get_post_meta($id, '_kk_ratings_avg', true):'0').'/5';
$cast = (get_post_meta($id, '_kk_ratings_casts', true)?get_post_meta($id, '_kk_ratings_casts', true):'0').' votes';
$per = ($raw>0?ceil((($raw/$cast)/5)*100):0).'%';
$row = $avg . ' (' . $per . ') ' . $cast;
switch($Columns)
{
case 'kk_star_ratings' : echo $row; break;
}
endif;
}
public function kk_star_rating($pid=false)
{
if($this->options['enable'])
return $this->markup($pid);
return '';
}
public function kk_star_ratings_get($total=5, $cat=false)
{
global $wpdb;
$table = $wpdb->prefix . 'postmeta';
if(!$cat)
$rated_posts = $wpdb->get_results("SELECT a.ID, a.post_title, b.meta_value AS 'ratings' FROM " . $wpdb->posts . " a, $table b WHERE a.post_status='publish' AND a.ID=b.post_id AND b.meta_key='_kk_ratings_avg' ORDER BY b.meta_value DESC LIMIT $total");
else
{
$table2 = $wpdb->prefix . 'term_taxonomy';
$table3 = $wpdb->prefix . 'term_relationships';
$rated_posts = $wpdb->get_results("SELECT a.ID, a.post_title, b.meta_value AS 'ratings' FROM " . $wpdb->posts . " a, $table b, $table2 c, $table3 d WHERE c.term_taxonomy_id=d.term_taxonomy_id AND c.term_id=$cat AND d.object_id=a.ID AND a.post_status='publish' AND a.ID=b.post_id AND b.meta_key='_kk_ratings_avg' ORDER BY b.meta_value DESC LIMIT $total");
}
return $rated_posts;
}
}
// Instantiate the plugin
$kkratings = new kk_Ratings('kk-ratings');
register_activation_hook(__FILE__, array($kkratings, 'activate'));
add_action('wp_head', array($kkratings, 'css'));
add_action('wp_print_scripts', array($kkratings, 'js'));
add_action('admin_init', array($kkratings, 'admin_init'));
add_action('admin_menu', array($kkratings, 'menu'));
add_action('init', array($kkratings, 'init'));
// add shortcode handler
add_shortcode('kkratings', array($kkratings, 'do_it_manually'));
// ADD COLUMNS TO POST AND PAGE TABLES IN ADMIN (as of 1.6)
add_filter( 'manage_posts_columns', array($kkratings, 'add_column') );
add_filter( 'manage_pages_columns', array($kkratings, 'add_column') );
add_filter( 'manage_posts_custom_column', array($kkratings, 'add_row'), 10, 2 );
add_filter( 'manage_pages_custom_column', array($kkratings, 'add_row'), 10, 2 );
function kk_star_ratings($pid=false)
{
global $kkratings;
return $kkratings->kk_star_rating($pid);
}
function kk_star_ratings_get($lim=5, $cat=false)
{
global $kkratings;
return $kkratings->kk_star_ratings_get($lim, $cat);
}
require_once('widget.php');
endif;
?>