2011-08-09 15:16:18 +00:00
< ? php
/**
* Product Class
*
2011-08-10 17:11:11 +00:00
* The WooCommerce product class handles individual product data .
2011-08-09 15:16:18 +00:00
*
2011-08-10 17:11:11 +00:00
* @ class woocommerce_product
* @ package WooCommerce
* @ category Class
* @ author WooThemes
2011-08-09 15:16:18 +00:00
*/
2011-08-10 17:11:11 +00:00
class woocommerce_product {
2011-08-09 15:16:18 +00:00
var $id ;
2011-10-26 18:45:38 +00:00
var $product_custom_fields ;
2011-08-09 15:16:18 +00:00
var $exists ;
var $attributes ;
2011-08-18 23:14:35 +00:00
var $children ;
2011-08-09 15:16:18 +00:00
var $post ;
2011-11-05 19:03:03 +00:00
var $downloadable ;
var $virtual ;
2011-08-17 23:42:07 +00:00
var $sku ;
var $price ;
var $visibility ;
2011-08-09 15:16:18 +00:00
var $stock ;
2011-08-17 23:42:07 +00:00
var $stock_status ;
var $backorders ;
2011-08-18 23:14:35 +00:00
var $manage_stock ;
var $sale_price ;
var $regular_price ;
var $weight ;
2011-10-08 11:57:04 +00:00
var $length ;
var $width ;
var $height ;
2011-08-18 23:14:35 +00:00
var $tax_status ;
var $tax_class ;
var $upsell_ids ;
var $crosssell_ids ;
2011-08-09 15:16:18 +00:00
var $product_type ;
2011-08-21 13:28:54 +00:00
var $total_stock ;
2011-09-03 22:37:16 +00:00
var $sale_price_dates_from ;
var $sale_price_dates_to ;
2011-10-04 23:00:35 +00:00
var $min_variation_price ;
var $max_variation_price ;
2011-11-13 12:07:29 +00:00
var $featured ;
2011-08-09 15:16:18 +00:00
/**
* Loads all product data from custom fields
*
* @ param int $id ID of the product to load
*/
2011-08-10 17:11:11 +00:00
function woocommerce_product ( $id ) {
2011-08-09 15:16:18 +00:00
2011-09-03 22:37:16 +00:00
$this -> id = ( int ) $id ;
2011-08-09 15:16:18 +00:00
2011-10-26 18:45:38 +00:00
$this -> product_custom_fields = get_post_custom ( $this -> id );
2011-08-09 15:16:18 +00:00
2011-10-26 18:45:38 +00:00
$this -> exists = ( sizeof ( $this -> product_custom_fields ) > 0 ) ? true : false ;
2011-08-17 23:42:07 +00:00
// Define the data we're going to load: Key => Default value
$load_data = array (
'sku' => $this -> id ,
2011-11-05 19:03:03 +00:00
'downloadable' => 'no' ,
'virtual' => 'no' ,
2011-08-27 20:07:16 +00:00
'price' => '' ,
2011-08-17 23:42:07 +00:00
'visibility' => 'hidden' ,
'stock' => 0 ,
'stock_status' => 'instock' ,
'backorders' => 'no' ,
'manage_stock' => 'no' ,
'sale_price' => '' ,
'regular_price' => '' ,
'weight' => '' ,
2011-10-08 11:57:04 +00:00
'length' => '' ,
'width' => '' ,
'height' => '' ,
2011-08-17 23:42:07 +00:00
'tax_status' => 'taxable' ,
'tax_class' => '' ,
'upsell_ids' => array (),
2011-10-04 23:00:35 +00:00
'crosssell_ids' => array (),
'sale_price_dates_from' => '' ,
'sale_price_dates_to' => '' ,
'min_variation_price' => '' ,
2011-11-13 12:07:29 +00:00
'max_variation_price' => '' ,
'featured' => 'no'
2011-08-17 23:42:07 +00:00
);
// Load the data from the custom fields
2011-11-13 02:15:00 +00:00
foreach ( $load_data as $key => $default ) $this -> $key = ( isset ( $this -> product_custom_fields [ $key ][ 0 ]) && $this -> product_custom_fields [ $key ][ 0 ] !== '' ) ? $this -> product_custom_fields [ $key ][ 0 ] : $default ;
2011-08-17 23:42:07 +00:00
// Get product type
2011-11-13 02:15:00 +00:00
$transient_name = 'woocommerce_product_type_' . $this -> id ;
2011-08-21 13:28:54 +00:00
2011-11-13 02:15:00 +00:00
if ( false === ( $this -> product_type = get_transient ( $transient_name ) ) ) :
$terms = wp_get_object_terms ( $id , 'product_type' , array ( 'fields' => 'names' ) );
$this -> product_type = ( isset ( $terms [ 0 ])) ? sanitize_title ( $terms [ 0 ]) : 'simple' ;
set_transient ( $transient_name , $this -> product_type );
endif ;
// Check sale dates
2011-09-23 08:38:09 +00:00
$this -> check_sale_price ();
2011-08-09 15:16:18 +00:00
}
2011-08-22 14:10:22 +00:00
/**
* Get SKU ( Stock - keeping unit ) - product uniqe ID
*
* @ return mixed
*/
function get_sku () {
return $this -> sku ;
}
2011-11-13 02:15:00 +00:00
/**
* Get total stock
*
* This is the stock of parent and children combined
*/
function get_total_stock () {
if ( is_null ( $this -> total_stock )) :
2011-11-13 12:07:29 +00:00
$transient_name = 'woocommerce_product_total_stock_' . $this -> id ;
if ( false === ( $this -> total_stock = get_transient ( $transient_name ) ) ) :
$this -> total_stock = $this -> stock ;
if ( sizeof ( $this -> get_children ()) > 0 ) foreach ( $this -> get_children () as $child_id ) :
$stock = get_post_meta ( $child_id , 'stock' , true );
if ( $stock != '' ) :
$this -> total_stock += $stock ;
2011-11-13 02:15:00 +00:00
endif ;
2011-11-13 12:07:29 +00:00
endforeach ;
set_transient ( $transient_name , $this -> total_stock );
endif ;
2011-11-13 02:15:00 +00:00
endif ;
return ( int ) $this -> total_stock ;
}
2011-08-22 14:10:22 +00:00
2011-08-09 15:16:18 +00:00
/** Returns the product's children */
function get_children () {
if ( ! is_array ( $this -> children )) :
$this -> children = array ();
2011-09-23 08:38:09 +00:00
if ( $this -> is_type ( 'variable' ) || $this -> is_type ( 'grouped' )) :
2011-10-26 18:45:38 +00:00
$child_post_type = ( $this -> is_type ( 'variable' )) ? 'product_variation' : 'product' ;
2011-09-23 08:38:09 +00:00
2011-11-13 12:07:29 +00:00
$transient_name = 'woocommerce_product_children_ids_' . $this -> id ;
if ( false === ( $this -> children = get_transient ( $transient_name ) ) ) :
$this -> children = get_posts ( 'post_parent=' . $this -> id . '&post_type=' . $child_post_type . '&orderby=menu_order&order=ASC&fields=ids&post_status=any' );
set_transient ( $transient_name , $this -> children );
endif ;
2011-08-09 15:16:18 +00:00
endif ;
endif ;
2011-08-22 14:10:22 +00:00
return ( array ) $this -> children ;
2011-08-09 15:16:18 +00:00
}
2011-11-13 12:07:29 +00:00
function get_child ( $child_id ) {
if ( $this -> is_type ( 'variable' )) :
$child = & new woocommerce_product_variation ( $child_id , $this -> id , $this -> product_custom_fields );
else :
$child = & new woocommerce_product ( $child_id );
endif ;
return $child ;
}
2011-08-09 15:16:18 +00:00
/**
* Reduce stock level of the product
*
* @ param int $by Amount to reduce by
*/
function reduce_stock ( $by = 1 ) {
if ( $this -> managing_stock ()) :
2011-08-21 16:47:49 +00:00
$this -> stock = $this -> stock - $by ;
2011-11-13 02:15:00 +00:00
$this -> total_stock = $this -> get_total_stock () - $by ;
2011-08-21 16:47:49 +00:00
update_post_meta ( $this -> id , 'stock' , $this -> stock );
2011-08-18 23:14:35 +00:00
// Out of stock attribute
2011-11-13 02:15:00 +00:00
if ( ! $this -> is_in_stock ()) :
update_post_meta ( $this -> id , 'stock_status' , 'outofstock' );
2011-11-13 12:07:29 +00:00
$woocommerce -> clear_product_transients ( $this -> id ); // Clear transient
2011-11-13 02:15:00 +00:00
endif ;
2011-08-18 23:14:35 +00:00
2011-08-21 16:47:49 +00:00
return $this -> stock ;
2011-08-09 15:16:18 +00:00
endif ;
}
/**
* Increase stock level of the product
*
* @ param int $by Amount to increase by
*/
function increase_stock ( $by = 1 ) {
if ( $this -> managing_stock ()) :
2011-08-21 16:47:49 +00:00
$this -> stock = $this -> stock + $by ;
2011-11-13 02:15:00 +00:00
$this -> total_stock = $this -> get_total_stock () + $by ;
2011-08-21 16:47:49 +00:00
update_post_meta ( $this -> id , 'stock' , $this -> stock );
2011-08-18 23:14:35 +00:00
// Out of stock attribute
if ( $this -> is_in_stock ()) update_post_meta ( $this -> id , 'stock_status' , 'instock' );
2011-08-21 16:47:49 +00:00
return $this -> stock ;
2011-08-09 15:16:18 +00:00
endif ;
}
/**
* Checks the product type
2011-11-17 10:40:32 +00:00
*
* Backwards compat with downloadable / virtual
2011-08-09 15:16:18 +00:00
*/
function is_type ( $type ) {
if ( is_array ( $type ) && in_array ( $this -> product_type , $type )) return true ;
2011-11-17 10:40:32 +00:00
if ( $this -> product_type == $type ) return true ;
2011-08-09 15:16:18 +00:00
return false ;
}
2011-11-05 19:03:03 +00:00
/**
* Checks if a product is downloadable
*/
function is_downloadable () {
if ( $this -> downloadable == 'yes' ) return true ; else return false ;
}
/**
* Checks if a product is virtual ( has no shipping )
*/
function is_virtual () {
if ( $this -> virtual == 'yes' ) return true ; else return false ;
}
/**
* Checks if a product needs shipping
*/
function needs_shipping () {
if ( $this -> is_virtual ()) return false ; else return true ;
}
2011-08-09 15:16:18 +00:00
/** Returns whether or not the product has any child product */
2011-09-21 15:13:53 +00:00
function has_child () {
2011-09-23 08:38:09 +00:00
return sizeof ( $this -> get_children ()) ? true : false ;
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product post exists */
function exists () {
if ( $this -> exists ) return true ;
return false ;
}
/** Returns whether or not the product is taxable */
function is_taxable () {
2011-08-17 23:42:07 +00:00
if ( $this -> tax_status == 'taxable' ) return true ;
2011-08-09 15:16:18 +00:00
return false ;
}
/** Returns whether or not the product shipping is taxable */
function is_shipping_taxable () {
2011-08-17 23:42:07 +00:00
if ( $this -> tax_status == 'taxable' || $this -> tax_status == 'shipping' ) return true ;
2011-08-09 15:16:18 +00:00
return false ;
}
/** Get the product's post data */
function get_post_data () {
if ( empty ( $this -> post )) :
$this -> post = get_post ( $this -> id );
endif ;
return $this -> post ;
}
/** Get the title of the post */
2011-08-30 11:24:28 +00:00
function get_title () {
2011-08-09 15:16:18 +00:00
$this -> get_post_data ();
2011-11-13 19:01:10 +00:00
return apply_filters ( 'woocommerce_product_title' , apply_filters ( 'the_title' , $this -> post -> post_title ), $this );
2011-08-09 15:16:18 +00:00
}
/** Get the add to url */
function add_to_cart_url () {
2011-09-06 11:11:22 +00:00
global $woocommerce ;
2011-08-09 15:16:18 +00:00
if ( $this -> is_type ( 'variable' )) :
$url = add_query_arg ( 'add-to-cart' , 'variation' );
$url = add_query_arg ( 'product' , $this -> id , $url );
elseif ( $this -> has_child () ) :
$url = add_query_arg ( 'add-to-cart' , 'group' );
$url = add_query_arg ( 'product' , $this -> id , $url );
else :
$url = add_query_arg ( 'add-to-cart' , $this -> id );
endif ;
2011-09-06 11:11:22 +00:00
$url = $woocommerce -> nonce_url ( 'add_to_cart' , $url );
2011-08-09 15:16:18 +00:00
return $url ;
}
/** Returns whether or not the product is stock managed */
function managing_stock () {
2011-08-10 17:11:11 +00:00
if ( get_option ( 'woocommerce_manage_stock' ) == 'yes' ) :
2011-08-17 23:42:07 +00:00
if ( isset ( $this -> manage_stock ) && $this -> manage_stock == 'yes' ) return true ;
2011-08-09 15:16:18 +00:00
endif ;
return false ;
}
/** Returns whether or not the product is in stock */
function is_in_stock () {
if ( $this -> managing_stock ()) :
if ( ! $this -> backorders_allowed ()) :
2011-11-13 02:15:00 +00:00
if ( $this -> get_total_stock () == 0 || $this -> get_total_stock () < 0 ) :
2011-08-09 15:16:18 +00:00
return false ;
else :
2011-08-17 23:42:07 +00:00
if ( $this -> stock_status == 'instock' ) return true ;
2011-08-09 15:16:18 +00:00
return false ;
endif ;
else :
2011-08-17 23:42:07 +00:00
if ( $this -> stock_status == 'instock' ) return true ;
2011-08-09 15:16:18 +00:00
return false ;
endif ;
endif ;
2011-08-18 23:14:35 +00:00
if ( $this -> stock_status == 'instock' ) return true ;
return false ;
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product can be backordered */
function backorders_allowed () {
2011-08-17 23:42:07 +00:00
if ( $this -> backorders == 'yes' || $this -> backorders == 'notify' ) return true ;
2011-08-09 15:16:18 +00:00
return false ;
}
/** Returns whether or not the product needs to notify the customer on backorder */
function backorders_require_notification () {
2011-08-17 23:42:07 +00:00
if ( $this -> backorders == 'notify' ) return true ;
2011-08-09 15:16:18 +00:00
return false ;
}
2011-08-22 14:10:22 +00:00
/**
* Returns number of items available for sale .
*
* @ return int
*/
function get_stock_quantity () {
2011-11-13 19:01:10 +00:00
return ( int ) $this -> stock ;
2011-08-22 14:10:22 +00:00
}
2011-08-09 15:16:18 +00:00
/** Returns whether or not the product has enough stock for the order */
function has_enough_stock ( $quantity ) {
2011-08-30 11:24:28 +00:00
if ( ! $this -> managing_stock ()) return true ;
2011-10-31 14:09:18 +00:00
2011-08-09 15:16:18 +00:00
if ( $this -> backorders_allowed ()) return true ;
if ( $this -> stock >= $quantity ) :
return true ;
endif ;
return false ;
}
/** Returns the availability of the product */
function get_availability () {
$availability = " " ;
$class = " " ;
if ( ! $this -> managing_stock ()) :
if ( $this -> is_in_stock ()) :
2011-08-10 17:11:11 +00:00
//$availability = __('In stock', 'woothemes'); /* Lets not bother showing stock if its not managed and is available */
2011-08-09 15:16:18 +00:00
else :
2011-08-10 17:11:11 +00:00
$availability = __ ( 'Out of stock' , 'woothemes' );
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock' ;
endif ;
else :
if ( $this -> is_in_stock ()) :
2011-11-13 02:15:00 +00:00
if ( $this -> get_total_stock () > 0 ) :
2011-08-10 17:11:11 +00:00
$availability = __ ( 'In stock' , 'woothemes' );
2011-08-09 15:16:18 +00:00
if ( $this -> backorders_allowed ()) :
if ( $this -> backorders_require_notification ()) :
$availability .= ' – ' . $this -> stock . ' ' ;
2011-08-10 17:11:11 +00:00
$availability .= __ ( 'available' , 'woothemes' );
$availability .= __ ( ' (backorders allowed)' , 'woothemes' );
2011-08-09 15:16:18 +00:00
endif ;
else :
$availability .= ' – ' . $this -> stock . ' ' ;
2011-08-10 17:11:11 +00:00
$availability .= __ ( 'available' , 'woothemes' );
2011-08-09 15:16:18 +00:00
endif ;
else :
if ( $this -> backorders_allowed ()) :
if ( $this -> backorders_require_notification ()) :
2011-08-10 17:11:11 +00:00
$availability = __ ( 'Available on backorder' , 'woothemes' );
2011-08-09 15:16:18 +00:00
else :
2011-08-10 17:11:11 +00:00
$availability = __ ( 'In stock' , 'woothemes' );
2011-08-09 15:16:18 +00:00
endif ;
else :
2011-08-10 17:11:11 +00:00
$availability = __ ( 'Out of stock' , 'woothemes' );
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock' ;
endif ;
endif ;
else :
if ( $this -> backorders_allowed ()) :
2011-08-10 17:11:11 +00:00
$availability = __ ( 'Available on backorder' , 'woothemes' );
2011-08-09 15:16:18 +00:00
else :
2011-08-10 17:11:11 +00:00
$availability = __ ( 'Out of stock' , 'woothemes' );
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock' ;
endif ;
endif ;
endif ;
return array ( 'availability' => $availability , 'class' => $class );
}
/** Returns whether or not the product is featured */
function is_featured () {
2011-11-13 12:07:29 +00:00
if ( $this -> featured == 'yes' ) return true ; else return false ;
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product is visible */
function is_visible () {
2011-08-18 23:14:35 +00:00
// Out of stock visibility
if ( get_option ( 'woocommerce_hide_out_of_stock_items' ) == 'yes' ) :
if ( ! $this -> is_in_stock ()) return false ;
endif ;
// visibility setting
2011-08-09 15:16:18 +00:00
if ( $this -> visibility == 'hidden' ) return false ;
if ( $this -> visibility == 'visible' ) return true ;
if ( $this -> visibility == 'search' && is_search ()) return true ;
if ( $this -> visibility == 'search' && ! is_search ()) return false ;
if ( $this -> visibility == 'catalog' && is_search ()) return false ;
if ( $this -> visibility == 'catalog' && ! is_search ()) return true ;
}
/** Returns whether or not the product is on sale */
function is_on_sale () {
if ( $this -> has_child () ) :
2011-11-13 12:07:29 +00:00
foreach ( $this -> get_children () as $child_id ) :
2011-11-17 19:01:35 +00:00
$sale_price = get_post_meta ( $child_id , 'sale_price' , true );
if ( $sale_price > 0 && $sale_price == $this -> price ) return true ;
2011-08-09 15:16:18 +00:00
endforeach ;
else :
2011-09-23 08:38:09 +00:00
if ( $this -> sale_price && $this -> sale_price == $this -> price ) return true ;
2011-08-09 15:16:18 +00:00
endif ;
return false ;
}
/** Returns the product's weight */
function get_weight () {
2011-08-17 23:42:07 +00:00
if ( $this -> weight ) return $this -> weight ;
2011-08-09 15:16:18 +00:00
}
2011-11-06 13:45:18 +00:00
/** Adjust a products price dynamically */
function adjust_price ( $price ) {
if ( $price > 0 ) :
$this -> price += $price ;
endif ;
}
2011-08-09 15:16:18 +00:00
/** Returns the product's price */
function get_price () {
return $this -> price ;
}
2011-10-08 10:39:26 +00:00
/** Returns the price (excluding tax) - ignores tax_class filters since the price may *include* tax and thus needs subtracting */
2011-08-09 15:16:18 +00:00
function get_price_excluding_tax () {
$price = $this -> price ;
2011-08-10 17:11:11 +00:00
if ( get_option ( 'woocommerce_prices_include_tax' ) == 'yes' ) :
2011-08-09 15:16:18 +00:00
if ( $rate = $this -> get_tax_base_rate () ) :
if ( $rate > 0 ) :
2011-08-10 17:11:11 +00:00
$_tax = & new woocommerce_tax ();
2011-08-09 15:16:18 +00:00
$tax_amount = $_tax -> calc_tax ( $price , $rate , true );
$price = $price - $tax_amount ;
2011-08-11 22:39:02 +00:00
// Round
$price = round ( $price * 100 ) / 100 ;
// Format
$price = number_format ( $price , 2 , '.' , '' );
2011-08-09 15:16:18 +00:00
endif ;
endif ;
endif ;
return $price ;
}
2011-10-07 22:24:11 +00:00
/** Returns the tax class */
function get_tax_class () {
return apply_filters ( 'woocommerce_product_tax_class' , $this -> tax_class , $this );
}
2011-08-09 15:16:18 +00:00
/** Returns the base tax rate */
function get_tax_base_rate () {
2011-08-10 17:11:11 +00:00
if ( $this -> is_taxable () && get_option ( 'woocommerce_calc_taxes' ) == 'yes' ) :
2011-08-09 15:16:18 +00:00
2011-08-10 17:11:11 +00:00
$_tax = & new woocommerce_tax ();
2011-10-08 10:39:26 +00:00
$rate = $_tax -> get_shop_base_rate ( $this -> tax_class ); // Get tax class directly - ignore filters
2011-08-09 15:16:18 +00:00
return $rate ;
endif ;
}
/** Returns the price in html format */
function get_price_html () {
$price = '' ;
2011-09-23 08:38:09 +00:00
if ( $this -> is_type ( 'grouped' )) :
2011-08-09 15:16:18 +00:00
$min_price = '' ;
$max_price = '' ;
2011-11-13 12:07:29 +00:00
foreach ( $this -> get_children () as $child_id ) :
$child_price = get_post_meta ( $child_id , 'price' , true );
2011-08-09 15:16:18 +00:00
if ( $child_price < $min_price || $min_price == '' ) $min_price = $child_price ;
if ( $child_price > $max_price || $max_price == '' ) $max_price = $child_price ;
endforeach ;
2011-10-26 19:10:36 +00:00
$price .= '<span class="from">' . __ ( 'From:' , 'woothemes' ) . ' </span>' . woocommerce_price ( $min_price );
2011-09-09 14:23:32 +00:00
2011-09-21 16:58:05 +00:00
$price = apply_filters ( 'woocommerce_grouped_price_html' , $price , $this );
2011-09-09 14:23:32 +00:00
2011-08-09 15:16:18 +00:00
elseif ( $this -> is_type ( 'variable' )) :
2011-10-04 23:00:35 +00:00
2011-10-26 19:10:36 +00:00
if ( ! $this -> min_variation_price || $this -> min_variation_price !== $this -> max_variation_price ) $price .= '<span class="from">' . __ ( 'From:' , 'woothemes' ) . ' </span>' ;
2011-10-04 23:00:35 +00:00
$price .= woocommerce_price ( $this -> get_price ());
2011-09-09 14:23:32 +00:00
2011-09-21 16:58:05 +00:00
$price = apply_filters ( 'woocommerce_variable_price_html' , $price , $this );
2011-09-09 14:23:32 +00:00
2011-08-09 15:16:18 +00:00
else :
if ( $this -> price ) :
2011-08-17 23:42:07 +00:00
if ( $this -> is_on_sale () && isset ( $this -> regular_price )) :
2011-09-09 14:23:32 +00:00
2011-08-17 23:42:07 +00:00
$price .= '<del>' . woocommerce_price ( $this -> regular_price ) . '</del> <ins>' . woocommerce_price ( $this -> get_price ()) . '</ins>' ;
2011-09-09 14:23:32 +00:00
2011-09-21 16:58:05 +00:00
$price = apply_filters ( 'woocommerce_sale_price_html' , $price , $this );
2011-09-09 14:23:32 +00:00
2011-08-09 15:16:18 +00:00
else :
2011-09-09 14:23:32 +00:00
2011-08-10 17:11:11 +00:00
$price .= woocommerce_price ( $this -> get_price ());
2011-09-09 14:23:32 +00:00
2011-09-21 16:58:05 +00:00
$price = apply_filters ( 'woocommerce_price_html' , $price , $this );
2011-09-09 14:23:32 +00:00
2011-08-09 15:16:18 +00:00
endif ;
2011-08-27 20:07:16 +00:00
elseif ( $this -> price === '' ) :
2011-11-05 19:12:51 +00:00
$price = apply_filters ( 'woocommerce_empty_price_html' , '' , $this );
2011-08-27 20:07:16 +00:00
elseif ( $this -> price === '0' ) :
2011-09-09 14:23:32 +00:00
$price = __ ( 'Free!' , 'woothemes' );
2011-09-21 16:58:05 +00:00
$price = apply_filters ( 'woocommerce_free_price_html' , $price , $this );
2011-09-09 14:23:32 +00:00
2011-08-09 15:16:18 +00:00
endif ;
endif ;
2011-09-09 14:23:32 +00:00
2011-08-09 15:16:18 +00:00
return $price ;
}
2011-10-31 14:49:30 +00:00
/** Returns the product rating in html format - ratings are stored in transient cache */
2011-08-28 12:07:33 +00:00
function get_rating_html ( $location = '' ) {
2011-08-28 12:04:05 +00:00
2011-08-28 12:07:33 +00:00
if ( $location ) $location = '_' . $location ;
$star_size = apply_filters ( 'woocommerce_star_rating_size' . $location , 16 );
2011-10-31 14:49:30 +00:00
if ( false === ( $average_rating = get_transient ( $this -> id . '_woocommerce_average_rating' ) ) ) :
2011-08-28 12:04:05 +00:00
2011-10-31 14:49:30 +00:00
global $wpdb ;
$count = $wpdb -> get_var ( "
SELECT COUNT ( meta_value ) FROM $wpdb -> commentmeta
LEFT JOIN $wpdb -> comments ON $wpdb -> commentmeta . comment_id = $wpdb -> comments . comment_ID
WHERE meta_key = 'rating'
AND comment_post_ID = $this -> id
AND comment_approved = '1'
AND meta_value > 0
" );
$ratings = $wpdb -> get_var ( "
SELECT SUM ( meta_value ) FROM $wpdb -> commentmeta
LEFT JOIN $wpdb -> comments ON $wpdb -> commentmeta . comment_id = $wpdb -> comments . comment_ID
WHERE meta_key = 'rating'
AND comment_post_ID = $this -> id
AND comment_approved = '1'
" );
if ( $count > 0 ) :
$average_rating = number_format ( $ratings / $count , 2 );
else :
$average_rating = '' ;
endif ;
2011-08-28 12:04:05 +00:00
2011-10-31 14:49:30 +00:00
set_transient ( $this -> id . '_woocommerce_average_rating' , $average_rating );
endif ;
if ( $average_rating > 0 ) :
return '<div class="star-rating" title="' . sprintf ( __ ( 'Rated %s out of 5' , 'woothemes' ), $average_rating ) . '"><span style="width:' . ( $average_rating * $star_size ) . 'px"><span class="rating">' . $average_rating . '</span> ' . __ ( 'out of 5' , 'woothemes' ) . '</span></div>' ;
2011-08-28 12:04:05 +00:00
else :
return '' ;
endif ;
}
2011-08-09 15:16:18 +00:00
/** Returns the upsell product ids */
function get_upsells () {
2011-08-19 20:11:04 +00:00
return ( array ) maybe_unserialize ( $this -> upsell_ids );
2011-08-09 15:16:18 +00:00
}
/** Returns the crosssell product ids */
function get_cross_sells () {
2011-08-19 20:11:04 +00:00
return ( array ) maybe_unserialize ( $this -> crosssell_ids );
2011-08-09 15:16:18 +00:00
}
/** Returns the product categories */
function get_categories ( $sep = ', ' , $before = '' , $after = '' ) {
return get_the_term_list ( $this -> id , 'product_cat' , $before , $sep , $after );
}
/** Returns the product tags */
function get_tags ( $sep = ', ' , $before = '' , $after = '' ) {
return get_the_term_list ( $this -> id , 'product_tag' , $before , $sep , $after );
}
/** Get and return related products */
function get_related ( $limit = 5 ) {
2011-11-13 12:17:52 +00:00
global $woocommerce ;
2011-08-09 15:16:18 +00:00
// Related products are found from category and tag
$tags_array = array ( 0 );
$cats_array = array ( 0 );
// Get tags
$terms = wp_get_post_terms ( $this -> id , 'product_tag' );
2011-11-13 12:17:52 +00:00
foreach ( $terms as $term ) $tags_array [] = $term -> term_id ;
2011-08-09 15:16:18 +00:00
$terms = wp_get_post_terms ( $this -> id , 'product_cat' );
2011-11-13 12:17:52 +00:00
foreach ( $terms as $term ) $cats_array [] = $term -> term_id ;
// Meta query
$meta_query = array ();
$meta_query [] = $woocommerce -> query -> visibility_meta_query ();
$meta_query [] = $woocommerce -> query -> stock_status_meta_query ();
// Get the posts
$related_posts = get_posts ( array (
'orderby' => 'rand' ,
'posts_per_page' => $limit ,
'post_type' => 'product' ,
'fields' => 'ids' ,
'meta_query' => $meta_query ,
'tax_query' => array (
'relation' => 'OR' ,
array (
'taxonomy' => 'product_cat' ,
'field' => 'id' ,
'terms' => $cats_array
),
array (
'taxonomy' => 'product_tag' ,
'field' => 'id' ,
'terms' => $tags_array
2011-08-09 15:16:18 +00:00
)
2011-11-13 12:17:52 +00:00
)
));
$related_posts = array_diff ( array ( $this -> id ), $related_posts );
2011-08-09 15:16:18 +00:00
2011-11-13 12:17:52 +00:00
return $related_posts ;
2011-08-09 15:16:18 +00:00
}
/** Returns product attributes */
function get_attributes () {
2011-11-13 02:15:00 +00:00
if ( ! is_array ( $this -> attributes )) :
if ( isset ( $this -> product_custom_fields [ 'product_attributes' ][ 0 ]))
$this -> attributes = maybe_unserialize ( maybe_unserialize ( $this -> product_custom_fields [ 'product_attributes' ][ 0 ] ));
else
$this -> attributes = array ();
endif ;
return ( array ) $this -> attributes ;
2011-08-09 15:16:18 +00:00
}
/** Returns whether or not the product has any attributes set */
function has_attributes () {
2011-11-13 02:15:00 +00:00
if ( sizeof ( $this -> get_attributes ()) > 0 ) :
foreach ( $this -> get_attributes () as $attribute ) :
2011-11-14 13:57:12 +00:00
if ( isset ( $attribute [ 'is_visible' ]) && $attribute [ 'is_visible' ]) return true ;
2011-08-09 15:16:18 +00:00
endforeach ;
endif ;
return false ;
}
/** Lists a table of attributes for the product page */
function list_attributes () {
2011-09-06 11:11:22 +00:00
global $woocommerce ;
2011-08-09 15:16:18 +00:00
$attributes = $this -> get_attributes ();
2011-11-14 17:18:13 +00:00
$show_dimensions = false ;
$has_dimensions = false ;
if ( get_option ( 'woocommerce_enable_dimension_product_attributes' ) == 'yes' ) :
$show_dimensions = true ;
$weight = '' ;
$dimensions = '' ;
$length = $this -> length ;
$width = $this -> width ;
$height = $this -> height ;
if ( $this -> get_weight ()) $weight = $this -> get_weight () . get_option ( 'woocommerce_weight_unit' );
if (( $length && $width && $height )) $dimensions = $length . get_option ( 'woocommerce_dimension_unit' ) . ' x ' . $width . get_option ( 'woocommerce_dimension_unit' ) . ' x ' . $height . get_option ( 'woocommerce_dimension_unit' );
if ( $weight || $dimensions ) $has_dimensions = true ;
endif ;
if ( sizeof ( $attributes ) > 0 || ( $show_dimensions && $has_dimensions )) :
2011-08-09 15:16:18 +00:00
echo '<table cellspacing="0" class="shop_attributes">' ;
$alt = 1 ;
2011-11-14 17:18:13 +00:00
if (( $show_dimensions && $has_dimensions )) :
if ( $weight ) :
$alt = $alt *- 1 ;
echo '<tr class="' ;
if ( $alt == 1 ) echo 'alt' ;
echo '"><th>' . __ ( 'Weight' , 'woothemes' ) . '</th><td>' . $weight . '</td></tr>' ;
endif ;
if ( $dimensions ) :
$alt = $alt *- 1 ;
echo '<tr class="' ;
if ( $alt == 1 ) echo 'alt' ;
echo '"><th>' . __ ( 'Dimensions' , 'woothemes' ) . '</th><td>' . $dimensions . '</td></tr>' ;
endif ;
endif ;
2011-08-09 15:16:18 +00:00
foreach ( $attributes as $attribute ) :
2011-11-14 13:57:12 +00:00
if ( ! isset ( $attribute [ 'is_visible' ]) || ! $attribute [ 'is_visible' ]) continue ;
2011-09-11 13:28:15 +00:00
2011-08-09 15:16:18 +00:00
$alt = $alt *- 1 ;
echo '<tr class="' ;
if ( $alt == 1 ) echo 'alt' ;
2011-09-06 11:11:22 +00:00
echo '"><th>' . $woocommerce -> attribute_label ( $attribute [ 'name' ] ) . '</th><td>' ;
2011-08-09 15:16:18 +00:00
2011-09-11 13:28:15 +00:00
if ( $attribute [ 'is_taxonomy' ]) :
$post_terms = wp_get_post_terms ( $this -> id , $attribute [ 'name' ] );
$values = array ();
foreach ( $post_terms as $term ) :
$values [] = $term -> name ;
endforeach ;
echo implode ( ', ' , $values );
else :
2011-10-31 00:08:41 +00:00
// Convert pipes to commas
$value = explode ( '|' , $attribute [ 'value' ]);
$value = implode ( ', ' , $value );
echo wpautop ( wptexturize ( $value ));
2011-09-11 13:28:15 +00:00
endif ;
2011-08-09 15:16:18 +00:00
echo '</td></tr>' ;
endforeach ;
echo '</table>' ;
endif ;
}
2011-08-22 14:10:22 +00:00
/**
* Return an array of attributes used for variations , as well as their possible values
*
* @ return two dimensional array of attributes and their available values
*/
2011-09-11 13:28:15 +00:00
function get_available_attribute_variations () {
2011-08-22 14:10:22 +00:00
if ( ! $this -> is_type ( 'variable' ) || ! $this -> has_child ()) return array ();
$attributes = $this -> get_attributes ();
if ( ! is_array ( $attributes )) return array ();
$available_attributes = array ();
foreach ( $attributes as $attribute ) {
2011-09-10 20:21:44 +00:00
if ( ! $attribute [ 'is_variation' ]) continue ;
2011-08-22 14:10:22 +00:00
$values = array ();
2011-09-11 13:28:15 +00:00
$attribute_field_name = 'attribute_' . sanitize_title ( $attribute [ 'name' ]);
2011-08-22 14:10:22 +00:00
2011-11-13 12:07:29 +00:00
foreach ( $this -> get_children () as $child_id ) {
if ( get_post_status ( $child_id ) != 'publish' ) continue ; // Disabled
$child = $this -> get_child ( $child_id );
$vattributes = $child -> get_variation_attributes ();
2011-08-22 14:10:22 +00:00
2011-11-13 12:07:29 +00:00
if ( is_array ( $vattributes )) {
foreach ( $vattributes as $name => $value ) {
if ( $name == $attribute_field_name ) {
$values [] = $value ;
2011-08-22 14:10:22 +00:00
}
}
}
}
// empty value indicates that all options for given attribute are available
if ( in_array ( '' , $values )) {
2011-09-11 13:28:15 +00:00
// Get all options
if ( $attribute [ 'is_taxonomy' ]) :
$options = array ();
$post_terms = wp_get_post_terms ( $this -> id , $attribute [ 'name' ] );
foreach ( $post_terms as $term ) :
$options [] = $term -> slug ;
endforeach ;
else :
$options = explode ( '|' , $attribute [ 'value' ]);
endif ;
$options = array_map ( 'trim' , $options );
2011-08-22 14:10:22 +00:00
$values = $options ;
}
2011-10-12 17:32:30 +00:00
2011-08-22 14:10:22 +00:00
$available_attributes [ $attribute [ 'name' ]] = array_unique ( $values );
}
2011-10-16 20:56:18 +00:00
2011-08-22 14:10:22 +00:00
return $available_attributes ;
}
2011-09-03 22:37:16 +00:00
2011-11-09 15:39:14 +00:00
/**
* Gets the main product image
*/
function get_image ( $size = 'shop_thumbnail' ) {
global $woocommerce ;
if ( has_post_thumbnail ( $this -> id )) :
echo get_the_post_thumbnail ( $this -> id , $size );
elseif ( $parent_id = wp_get_post_parent_id ( $this -> id ) && has_post_thumbnail ( $parent_id )) :
echo get_the_post_thumbnail ( $parent_id , $size );
else :
echo '<img src="' . $woocommerce -> plugin_url () . '/assets/images/placeholder.png" alt="Placeholder" width="' . $woocommerce -> get_image_size ( 'shop_thumbnail_image_width' ) . '" height="' . $woocommerce -> get_image_size ( 'shop_thumbnail_image_height' ) . '" />' ;
endif ;
}
2011-09-03 22:37:16 +00:00
/**
* Checks sale data to see if the product is due to go on sale / sale has expired , and updates the main price
*/
function check_sale_price () {
2011-11-04 20:46:06 +00:00
global $woocommerce ;
2011-09-03 22:37:16 +00:00
if ( $this -> sale_price_dates_from && $this -> sale_price_dates_from < strtotime ( 'NOW' )) :
if ( $this -> sale_price && $this -> price !== $this -> sale_price ) :
$this -> price = $this -> sale_price ;
update_post_meta ( $this -> id , 'price' , $this -> price );
2011-09-23 08:38:09 +00:00
// Grouped product prices and sale status are affected by children
$this -> grouped_product_sync ();
2011-09-03 22:37:16 +00:00
2011-11-04 20:46:06 +00:00
// Clear transient
2011-11-13 12:07:29 +00:00
$woocommerce -> clear_product_transients ( $this -> id );
2011-11-04 20:46:06 +00:00
2011-09-03 22:37:16 +00:00
endif ;
endif ;
if ( $this -> sale_price_dates_to && $this -> sale_price_dates_to < strtotime ( 'NOW' )) :
if ( $this -> regular_price && $this -> price !== $this -> regular_price ) :
$this -> price = $this -> regular_price ;
update_post_meta ( $this -> id , 'price' , $this -> price );
// Sale has expired - clear the schedule boxes
2011-09-20 16:43:09 +00:00
update_post_meta ( $this -> id , 'sale_price' , '' );
2011-09-03 22:37:16 +00:00
update_post_meta ( $this -> id , 'sale_price_dates_from' , '' );
update_post_meta ( $this -> id , 'sale_price_dates_to' , '' );
2011-09-23 08:38:09 +00:00
// Grouped product prices and sale status are affected by children
$this -> grouped_product_sync ();
2011-11-04 20:46:06 +00:00
// Clear transient
2011-11-13 12:07:29 +00:00
$woocommerce -> clear_product_transients ( $this -> id );
2011-09-03 22:37:16 +00:00
endif ;
endif ;
}
/**
* Sync grouped products with the childs lowest price ( so they can be sorted by price accurately )
**/
2011-09-23 08:38:09 +00:00
function grouped_product_sync () {
2011-09-03 22:37:16 +00:00
global $wpdb ;
$post_parent = $wpdb -> get_var ( " SELECT post_parent FROM $wpdb->posts WHERE ID = $this->id ; " );
if ( ! $post_parent ) return ;
$children_by_price = get_posts ( array (
'post_parent' => $post_parent ,
'orderby' => 'meta_value_num' ,
'order' => 'asc' ,
'meta_key' => 'price' ,
'posts_per_page' => 1 ,
2011-09-23 08:38:09 +00:00
'post_type' => 'product' ,
'fields' => 'ids'
2011-09-03 22:37:16 +00:00
));
if ( $children_by_price ) :
2011-09-23 08:38:09 +00:00
foreach ( $children_by_price as $child ) :
$child_price = get_post_meta ( $child , 'price' , true );
update_post_meta ( $post_parent , 'price' , $child_price );
endforeach ;
2011-09-03 22:37:16 +00:00
endif ;
}
2011-08-09 15:16:18 +00:00
}