woocommerce/widgets/widget-top_rated_products.php

192 lines
5.9 KiB
PHP
Raw Normal View History

2011-08-27 11:53:46 +00:00
<?php
/**
* Top Rated Products Widget
*
* Gets and displays top rated products in an unordered list
2012-08-14 17:37:50 +00:00
*
* @author WooThemes
* @category Widgets
* @package WooCommerce/Widgets
* @version 1.6.4
* @extends WP_Widget
2011-08-27 11:53:46 +00:00
*/
if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
2011-08-27 11:53:46 +00:00
class WooCommerce_Widget_Top_Rated_Products extends WP_Widget {
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
var $woo_widget_cssclass;
var $woo_widget_description;
var $woo_widget_idbase;
var $woo_widget_name;
2012-08-14 17:37:50 +00:00
/**
* constructor
*
* @access public
* @return void
*/
2011-08-27 11:53:46 +00:00
function WooCommerce_Widget_Top_Rated_Products() {
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
/* Widget variable settings. */
2012-11-15 17:46:24 +00:00
$this->woo_widget_cssclass = 'woocommerce widget_top_rated_products';
2012-01-05 11:31:22 +00:00
$this->woo_widget_description = __( 'Display a list of top rated products on your site.', 'woocommerce' );
2011-08-27 11:53:46 +00:00
$this->woo_widget_idbase = 'woocommerce_top_rated_products';
2012-10-16 09:45:33 +00:00
$this->woo_widget_name = __( 'WooCommerce Top Rated Products', 'woocommerce' );
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
/* Widget settings. */
$widget_ops = array( 'classname' => $this->woo_widget_cssclass, 'description' => $this->woo_widget_description );
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
/* Create the widget. */
$this->WP_Widget('top-rated-products', $this->woo_widget_name, $widget_ops);
2012-08-14 17:37:50 +00:00
add_action( 'save_post', array( $this, 'flush_widget_cache' ) );
add_action( 'deleted_post', array( $this, 'flush_widget_cache' ) );
add_action( 'switch_theme', array( $this, 'flush_widget_cache' ) );
2011-08-27 11:53:46 +00:00
}
2012-08-14 17:37:50 +00:00
/**
* widget function.
*
* @see WP_Widget
* @access public
* @param array $args
* @param array $instance
* @return void
*/
2011-08-27 11:53:46 +00:00
function widget($args, $instance) {
global $woocommerce;
2012-08-14 17:37:50 +00:00
2011-08-28 12:04:05 +00:00
$cache = wp_cache_get('widget_top_rated_products', 'widget');
2011-08-27 11:53:46 +00:00
if ( !is_array($cache) ) $cache = array();
if ( isset($cache[$args['widget_id']]) ) {
echo $cache[$args['widget_id']];
return;
2011-08-28 12:04:05 +00:00
}
2011-08-27 11:53:46 +00:00
ob_start();
extract($args);
2012-10-16 09:45:33 +00:00
$title = apply_filters('widget_title', empty($instance['title']) ? __('Top Rated Products', 'woocommerce' ) : $instance['title'], $instance, $this->id_base);
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
if ( !$number = (int) $instance['number'] ) $number = 10;
else if ( $number < 1 ) $number = 1;
else if ( $number > 15 ) $number = 15;
2012-08-14 17:37:50 +00:00
add_filter( 'posts_clauses', array( $this, 'order_by_rating_post_clauses' ) );
2012-08-14 17:37:50 +00:00
2012-03-14 11:41:25 +00:00
$query_args = array('posts_per_page' => $number, 'no_found_rows' => 1, 'post_status' => 'publish', 'post_type' => 'product' );
2012-08-14 17:37:50 +00:00
$query_args['meta_query'] = array();
2012-08-14 17:37:50 +00:00
$query_args['meta_query'][] = $woocommerce->query->stock_status_meta_query();
$query_args['meta_query'][] = $woocommerce->query->visibility_meta_query();
2012-08-14 17:37:50 +00:00
2011-09-26 14:12:39 +00:00
$top_rated_posts = new WP_Query( $query_args );
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
if ($top_rated_posts->have_posts()) :
echo $before_widget;
2012-08-14 17:37:50 +00:00
if ( $title ) echo $before_title . $title . $after_title;
2011-08-27 11:53:46 +00:00
?>
<ul class="product_list_widget">
2012-08-14 17:37:50 +00:00
<?php while ($top_rated_posts->have_posts()) : $top_rated_posts->the_post(); global $product;
2011-08-28 12:04:05 +00:00
?>
2011-09-21 06:50:40 +00:00
<li><a href="<?php echo esc_url( get_permalink( $top_rated_posts->post->ID ) ); ?>" title="<?php echo esc_attr($top_rated_posts->post->post_title ? $top_rated_posts->post->post_title : $top_rated_posts->post->ID); ?>">
2011-12-12 16:50:04 +00:00
<?php echo $product->get_image(); ?>
2012-08-14 17:37:50 +00:00
<?php if ( $top_rated_posts->post->post_title ) echo get_the_title( $top_rated_posts->post->ID ); else echo $top_rated_posts->post->ID; ?>
2011-12-12 16:50:04 +00:00
</a> <?php echo $product->get_rating_html('sidebar'); ?><?php echo $product->get_price_html(); ?></li>
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
<?php endwhile; ?>
</ul>
<?php
2012-08-14 17:37:50 +00:00
echo $after_widget;
2011-08-27 11:53:46 +00:00
endif;
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
wp_reset_query();
remove_filter( 'posts_clauses', array( $this, 'order_by_rating_post_clauses' ) );
2012-08-14 17:37:50 +00:00
2012-05-13 21:39:21 +00:00
$content = ob_get_clean();
if ( isset( $args['widget_id'] ) ) $cache[$args['widget_id']] = $content;
2012-08-14 17:37:50 +00:00
2012-05-13 21:39:21 +00:00
echo $content;
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
wp_cache_set('widget_top_rated_products', $cache, 'widget');
}
2012-08-14 17:37:50 +00:00
/**
* order_by_rating_post_clauses function.
*
* @access public
* @param array $args
* @return array
*/
2011-08-27 11:53:46 +00:00
function order_by_rating_post_clauses( $args ) {
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
global $wpdb;
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
$args['where'] .= " AND $wpdb->commentmeta.meta_key = 'rating' ";
2012-08-14 17:37:50 +00:00
$args['join'] .= "
2011-08-27 11:53:46 +00:00
LEFT JOIN $wpdb->comments ON($wpdb->posts.ID = $wpdb->comments.comment_post_ID)
LEFT JOIN $wpdb->commentmeta ON($wpdb->comments.comment_ID = $wpdb->commentmeta.comment_id)
";
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
$args['orderby'] = "$wpdb->commentmeta.meta_value DESC";
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
$args['groupby'] = "$wpdb->posts.ID";
2012-08-14 17:37:50 +00:00
2011-08-27 11:53:46 +00:00
return $args;
}
2012-08-14 17:37:50 +00:00
/**
* update function.
*
* @see WP_Widget->update
* @access public
* @param array $new_instance
* @param array $old_instance
* @return array
*/
2011-08-27 11:53:46 +00:00
function update( $new_instance, $old_instance ) {
$instance = $old_instance;
$instance['title'] = strip_tags($new_instance['title']);
$instance['number'] = (int) $new_instance['number'];
$this->flush_widget_cache();
$alloptions = wp_cache_get( 'alloptions', 'options' );
if ( isset($alloptions['widget_top_rated_products']) ) delete_option('widget_top_rated_products');
return $instance;
}
function flush_widget_cache() {
wp_cache_delete('widget_top_rated_products', 'widget');
}
2012-08-14 17:37:50 +00:00
/**
* form function.
*
* @see WP_Widget->form
* @access public
* @param array $instance
* @return void
*/
2011-08-27 11:53:46 +00:00
function form( $instance ) {
$title = isset($instance['title']) ? esc_attr($instance['title']) : '';
if ( !isset($instance['number']) || !$number = (int) $instance['number'] )
$number = 5;
?>
2012-10-16 09:45:33 +00:00
<p><label for="<?php echo $this->get_field_id('title'); ?>"><?php _e( 'Title:', 'woocommerce' ); ?></label>
2011-09-19 06:01:26 +00:00
<input class="widefat" id="<?php echo esc_attr( $this->get_field_id('title') ); ?>" name="<?php echo esc_attr( $this->get_field_name('title') ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" /></p>
2011-08-27 11:53:46 +00:00
2012-10-16 09:45:33 +00:00
<p><label for="<?php echo $this->get_field_id('number'); ?>"><?php _e( 'Number of products to show:', 'woocommerce' ); ?></label>
2011-09-19 06:01:26 +00:00
<input id="<?php echo esc_attr( $this->get_field_id('number') ); ?>" name="<?php echo esc_attr( $this->get_field_name('number') ); ?>" type="text" value="<?php echo esc_attr( $number ); ?>" size="3" /></p>
2011-08-27 11:53:46 +00:00
<?php
}
2012-08-14 17:37:50 +00:00
}