woocommerce/classes/class-wc-product.php

1718 lines
44 KiB
PHP
Raw Normal View History

2011-08-09 15:16:18 +00:00
<?php
/**
* Product Class
2012-08-06 23:33:52 +00:00
*
2011-08-10 17:11:11 +00:00
* The WooCommerce product class handles individual product data.
2011-08-09 15:16:18 +00:00
*
2012-01-27 16:38:39 +00:00
* @class WC_Product
2012-08-15 17:08:42 +00:00
* @version 1.6.4
* @package WooCommerce/Classes
* @author WooThemes
2011-08-09 15:16:18 +00:00
*/
2012-01-27 16:38:39 +00:00
class WC_Product {
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/** @var int The product (post) ID. */
2011-08-09 15:16:18 +00:00
var $id;
2012-08-15 17:08:42 +00:00
/** @var array Array of custom fields (meta) containing product data. */
var $product_custom_fields;
2012-08-15 17:08:42 +00:00
/** @var array Array of product attributes. */
2011-08-09 15:16:18 +00:00
var $attributes;
2012-08-15 17:08:42 +00:00
/** @var array Array of child products/posts/variations. */
2011-08-18 23:14:35 +00:00
var $children;
2012-08-15 17:08:42 +00:00
/** @var object The actual post object. */
2011-08-09 15:16:18 +00:00
var $post;
2012-08-15 17:08:42 +00:00
/** @var string "Yes" for downloadable products. */
var $downloadable;
2012-08-15 17:08:42 +00:00
/** @var string "Yes" for virtual products. */
var $virtual;
2012-08-15 17:08:42 +00:00
/** @var string The product SKU (stock keeping unit). */
2011-08-17 23:42:07 +00:00
var $sku;
2012-08-15 17:08:42 +00:00
/** @var string The product price. */
2011-08-17 23:42:07 +00:00
var $price;
2012-08-15 17:08:42 +00:00
/** @var string The product's visibility. */
2011-08-17 23:42:07 +00:00
var $visibility;
2012-08-15 17:08:42 +00:00
/** @var string The product's stock level (if applicable). */
2011-08-09 15:16:18 +00:00
var $stock;
2012-08-15 17:08:42 +00:00
/** @var string The product's stock status (instock or outofstock). */
2011-08-17 23:42:07 +00:00
var $stock_status;
2012-08-15 17:08:42 +00:00
/** @var string The product's backorder status. */
2011-08-17 23:42:07 +00:00
var $backorders;
2012-08-15 17:08:42 +00:00
/** @var bool True if the product is stock managed. */
2011-08-18 23:14:35 +00:00
var $manage_stock;
2012-08-15 17:08:42 +00:00
/** @var string The product's sale price. */
2011-08-18 23:14:35 +00:00
var $sale_price;
2012-08-15 17:08:42 +00:00
/** @var string The product's regular non-sale price. */
2011-08-18 23:14:35 +00:00
var $regular_price;
2012-08-15 17:08:42 +00:00
/** @var string The product's weight. */
2011-08-18 23:14:35 +00:00
var $weight;
2012-08-15 17:08:42 +00:00
/** @var string The product's length. */
2011-10-08 11:57:04 +00:00
var $length;
2012-08-15 17:08:42 +00:00
/** @var string The product's width. */
2011-10-08 11:57:04 +00:00
var $width;
2012-08-15 17:08:42 +00:00
/** @var string The product's height. */
2011-10-08 11:57:04 +00:00
var $height;
2012-08-15 17:08:42 +00:00
/** @var string The product's tax status. */
2011-08-18 23:14:35 +00:00
var $tax_status;
2012-08-15 17:08:42 +00:00
/** @var string The product's tax class. */
2011-08-18 23:14:35 +00:00
var $tax_class;
2012-08-15 17:08:42 +00:00
/** @var array Array of product ID's being up-sold. */
2011-08-18 23:14:35 +00:00
var $upsell_ids;
2012-08-15 17:08:42 +00:00
/** @var array Array of product ID's being cross-sold. */
2011-08-18 23:14:35 +00:00
var $crosssell_ids;
2012-08-15 17:08:42 +00:00
/** @var string The product's type (simple, variable etc). */
2011-08-09 15:16:18 +00:00
var $product_type;
2012-08-15 17:08:42 +00:00
/** @var string The product's total stock, including that of its children. */
var $total_stock;
2012-08-15 17:08:42 +00:00
/** @var string Date a sale starts. */
2011-09-03 22:37:16 +00:00
var $sale_price_dates_from;
2012-08-15 17:08:42 +00:00
/** @var string Data a sale ends. */
2011-09-03 22:37:16 +00:00
var $sale_price_dates_to;
2012-08-15 17:08:42 +00:00
/** @var string Used for variation prices. */
var $min_variation_price;
2012-08-15 17:08:42 +00:00
/** @var string Used for variation prices. */
var $max_variation_price;
2012-08-15 17:08:42 +00:00
/** @var string Used for variation prices. */
var $min_variation_regular_price;
2012-08-15 17:08:42 +00:00
/** @var string Used for variation prices. */
var $max_variation_regular_price;
2012-08-15 17:08:42 +00:00
/** @var string Used for variation prices. */
var $min_variation_sale_price;
2012-08-15 17:08:42 +00:00
/** @var string Used for variation prices. */
var $max_variation_sale_price;
2012-08-15 17:08:42 +00:00
/** @var string "Yes" for featured products. */
2011-11-13 12:07:29 +00:00
var $featured;
2012-08-15 17:08:42 +00:00
/** @var string Shipping class slug for the product. */
2011-12-02 20:48:07 +00:00
var $shipping_class;
2012-08-15 17:08:42 +00:00
/** @var int Shipping class ID for the product. */
2012-05-31 10:05:00 +00:00
var $shipping_class_id;
2012-08-15 17:08:42 +00:00
/** @var string Formatted LxWxH. */
var $dimensions;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
/**
2012-08-15 17:08:42 +00:00
* Loads all product data from custom fields.
2011-08-09 15:16:18 +00:00
*
2012-08-15 17:08:42 +00:00
* @param int $id ID of the product to load
2011-08-09 15:16:18 +00:00
*/
2012-01-27 16:38:39 +00:00
function __construct( $id ) {
2012-08-06 23:33:52 +00:00
2011-09-03 22:37:16 +00:00
$this->id = (int) $id;
2011-08-09 15:16:18 +00:00
$this->product_custom_fields = get_post_custom( $this->id );
2012-08-06 23:33:52 +00:00
2011-08-17 23:42:07 +00:00
// Define the data we're going to load: Key => Default value
$load_data = array(
2012-02-13 00:34:09 +00:00
'sku' => '',
'downloadable' => 'no',
'virtual' => 'no',
'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(),
'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' => '',
'min_variation_regular_price' => '',
'max_variation_regular_price' => '',
'min_variation_sale_price' => '',
'max_variation_sale_price' => '',
2011-11-13 12:07:29 +00:00
'featured' => 'no'
2011-08-17 23:42:07 +00:00
);
2012-08-06 23:33:52 +00:00
2011-08-17 23:42:07 +00:00
// Load the data from the custom fields
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;
2012-08-06 23:33:52 +00:00
2011-08-17 23:42:07 +00:00
// Get product type
2012-03-16 16:39:16 +00:00
$transient_name = 'wc_product_type_' . $this->id;
2012-08-06 23:33:52 +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
$this->check_sale_price();
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2011-08-22 14:10:22 +00:00
/**
2012-08-15 17:08:42 +00:00
* Get SKU (Stock-keeping unit) - product unique ID.
2012-08-06 23:33:52 +00:00
*
2012-08-15 17:08:42 +00:00
* @return string
2011-08-22 14:10:22 +00:00
*/
function get_sku() {
return $this->sku;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2011-11-13 02:15:00 +00:00
/**
2012-08-15 17:08:42 +00:00
* Get total stock.
2012-08-06 23:33:52 +00:00
*
2012-08-15 17:08:42 +00:00
* This is the stock of parent and children combined.
*
* @access public
* @return int
2011-11-13 02:15:00 +00:00
*/
function get_total_stock() {
2012-08-06 23:33:52 +00:00
2011-11-13 02:15:00 +00:00
if (is_null($this->total_stock)) :
2012-08-06 23:33:52 +00:00
2012-03-16 16:39:16 +00:00
$transient_name = 'wc_product_total_stock_' . $this->id;
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
if ( false === ( $this->total_stock = get_transient( $transient_name ) ) ) :
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
$this->total_stock = $this->stock;
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
if (sizeof($this->get_children())>0) foreach ($this->get_children() as $child_id) :
2012-08-06 23:33:52 +00:00
$stock = get_post_meta($child_id, '_stock', true);
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
if ( $stock!='' ) :
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
$this->total_stock += $stock;
2012-08-06 23:33:52 +00:00
2011-11-13 02:15:00 +00:00
endif;
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
endforeach;
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
set_transient( $transient_name, $this->total_stock );
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
endif;
2012-08-06 23:33:52 +00:00
2011-11-13 02:15:00 +00:00
endif;
2012-08-06 23:33:52 +00:00
2011-11-13 02:15:00 +00:00
return (int) $this->total_stock;
}
2012-08-06 23:33:52 +00:00
2012-04-20 11:09:49 +00:00
/**
* Return the products children posts.
2012-08-06 23:33:52 +00:00
*
2012-04-20 11:09:49 +00:00
* @access public
* @return array
*/
2011-08-09 15:16:18 +00:00
function get_children() {
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
if (!is_array($this->children)) :
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
$this->children = array();
2012-08-06 23:33:52 +00:00
if ($this->is_type('variable') || $this->is_type('grouped')) :
2012-08-06 23:33:52 +00:00
$child_post_type = ($this->is_type('variable')) ? 'product_variation' : 'product';
2012-08-06 23:33:52 +00:00
2012-03-16 16:39:16 +00:00
$transient_name = 'wc_product_children_ids_' . $this->id;
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
if ( false === ( $this->children = get_transient( $transient_name ) ) ) :
2012-08-06 23:33:52 +00:00
$this->children = get_posts( 'post_parent=' . $this->id . '&post_type=' . $child_post_type . '&orderby=menu_order&order=ASC&fields=ids&post_status=any&numberposts=-1' );
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
set_transient( $transient_name, $this->children );
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
endif;
2011-08-09 15:16:18 +00:00
endif;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
endif;
2012-08-06 23:33:52 +00:00
2011-08-22 14:10:22 +00:00
return (array) $this->children;
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2012-04-20 11:09:49 +00:00
/**
* get_child function.
2012-08-06 23:33:52 +00:00
*
2012-04-20 11:09:49 +00:00
* @access public
* @param mixed $child_id
* @return object WC_Product or WC_Product_variation
*/
2011-11-13 12:07:29 +00:00
function get_child( $child_id ) {
if ($this->is_type('variable')) :
2012-01-27 16:38:39 +00:00
$child = new WC_Product_Variation( $child_id, $this->id, $this->product_custom_fields );
2011-11-13 12:07:29 +00:00
else :
2012-01-27 16:38:39 +00:00
$child = new WC_Product( $child_id );
2011-11-13 12:07:29 +00:00
endif;
return $child;
}
2011-08-09 15:16:18 +00:00
2012-08-15 17:08:42 +00:00
2011-08-09 15:16:18 +00:00
/**
2012-08-15 17:08:42 +00:00
* Reduce stock level of the product.
2011-08-09 15:16:18 +00:00
*
2012-08-15 17:08:42 +00:00
* @access public
* @param int $by (default: 1) Amount to reduce by.
* @return int Stock
2011-08-09 15:16:18 +00:00
*/
function reduce_stock( $by = 1 ) {
global $woocommerce;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
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;
update_post_meta($this->id, '_stock', $this->stock);
2012-08-06 23:33:52 +00:00
2011-08-18 23:14:35 +00:00
// Out of stock attribute
2012-01-06 17:28:33 +00:00
if ($this->managing_stock() && !$this->backorders_allowed() && $this->get_total_stock()<=0) :
update_post_meta($this->id, '_stock_status', 'outofstock');
2011-11-13 02:15:00 +00:00
endif;
2012-08-06 23:33:52 +00:00
2012-03-06 18:13:08 +00:00
$woocommerce->clear_product_transients( $this->id ); // Clear transient
2012-08-06 23:33:52 +00:00
2011-08-21 16:47:49 +00:00
return $this->stock;
2011-08-09 15:16:18 +00:00
endif;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2011-08-09 15:16:18 +00:00
/**
2012-08-15 17:08:42 +00:00
* Increase stock level of the product.
2011-08-09 15:16:18 +00:00
*
2012-08-15 17:08:42 +00:00
* @access public
* @param int $by (default: 1) Amount to increase by
* @return int Stock
2011-08-09 15:16:18 +00:00
*/
function increase_stock( $by = 1 ) {
2012-02-16 19:15:52 +00:00
global $woocommerce;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
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;
update_post_meta($this->id, '_stock', $this->stock);
2012-08-06 23:33:52 +00:00
2011-08-18 23:14:35 +00:00
// Out of stock attribute
2012-01-06 17:28:33 +00:00
if ($this->managing_stock() && ($this->backorders_allowed() || $this->get_total_stock()>0)) :
update_post_meta($this->id, '_stock_status', 'instock');
endif;
2012-08-06 23:33:52 +00:00
2012-03-06 18:13:08 +00:00
$woocommerce->clear_product_transients( $this->id ); // Clear transient
2012-08-06 23:33:52 +00:00
2011-08-21 16:47:49 +00:00
return $this->stock;
2011-08-09 15:16:18 +00:00
endif;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2011-08-09 15:16:18 +00:00
/**
2012-08-15 17:08:42 +00:00
* Checks the product type.
*
* Backwards compat with downloadable/virtual.
*
2012-08-15 17:08:42 +00:00
* @access public
* @param mixed $type Array or string of types
* @return bool
2011-08-09 15:16:18 +00:00
*/
function is_type( $type ) {
2012-04-12 16:22:56 +00:00
if ( is_array( $type ) && in_array( $this->product_type, $type ) ) return true;
if ( $this->product_type == $type ) return true;
2011-08-09 15:16:18 +00:00
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Checks if a product is downloadable
2012-08-15 17:08:42 +00:00
*
* @access public
* @return bool
*/
function is_downloadable() {
2012-04-20 11:09:49 +00:00
if ( $this->downloadable == 'yes' ) return true; else return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2012-07-31 11:58:00 +00:00
/**
* Check if downloadable product has a file attached.
*
* @since 1.6.2
*
* @access public
* @param string $download_id file identifier
* @return bool Whether downloadable product has a file attached.
2012-07-31 11:58:00 +00:00
*/
function has_file( $download_id = '' ) {
2012-07-31 11:58:00 +00:00
if ( ! $this->is_downloadable() )
return false;
2012-08-06 23:33:52 +00:00
if ( $this->get_file_download_path( $download_id ) )
2012-07-31 11:58:00 +00:00
return true;
return false;
2012-07-31 11:58:00 +00:00
}
/**
* Get file download path identified by $download_id
*
* @access public
* @param string $download_id file identifier
* @return array
*/
function get_file_download_path( $download_id ) {
$file_path = '';
$file_paths = apply_filters( 'woocommerce_file_download_paths', get_post_meta( $this->id, '_file_paths', true ), $this->id, null, null );
if ( ! $download_id && count( $file_paths ) == 1 ) {
// backwards compatibility for old-style download URLs and template files
$file_path = array_shift( $file_paths );
} elseif ( isset( $file_paths[ $download_id ] ) ) {
$file_path = $file_paths[ $download_id ];
}
// allow overriding based on the particular file being requested
return apply_filters( 'woocommerce_file_download_path', $file_path, $this->id, $download_id );
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
2012-08-15 17:08:42 +00:00
* Checks if a product is virtual (has no shipping).
*
* @access public
* @return bool
*/
function is_virtual() {
2012-04-20 11:09:49 +00:00
if ( $this->virtual == 'yes' ) return true; else return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
2012-08-15 17:08:42 +00:00
* Checks if a product needs shipping.
*
* @access public
* @return bool
*/
function needs_shipping() {
2012-04-20 11:09:49 +00:00
if ( $this->is_virtual() ) return false; else return true;
}
2012-08-06 23:33:52 +00:00
2012-04-20 11:09:49 +00:00
/**
* Check if a product is sold individually (no quantities)
2012-08-06 23:33:52 +00:00
*
2012-04-20 11:09:49 +00:00
* @access public
* @return bool
*/
function is_sold_individually() {
$return = false;
2012-08-06 23:33:52 +00:00
2012-04-20 11:09:49 +00:00
// Sold individually if downloadable, virtual, and the option is enabled
if ( $this->is_downloadable() && $this->is_virtual() && get_option('woocommerce_limit_downloadable_product_qty') == 'yes' ) {
$return = true;
}
2012-08-06 23:33:52 +00:00
2012-04-20 11:09:49 +00:00
return apply_filters( 'woocommerce_is_sold_individually', $return, $this );
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product has any child product.
*
* @access public
* @return bool
*/
2011-09-21 15:13:53 +00:00
function has_child() {
2012-04-20 11:09:49 +00:00
return sizeof( $this->get_children() ) ? true : false;
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product post exists.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
function exists() {
2012-04-20 10:17:40 +00:00
global $wpdb;
if ( $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE ID = %d LIMIT 1;", $this->id ) ) > 0 ) return true;
2011-08-09 15:16:18 +00:00
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product is taxable.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
function is_taxable() {
2011-12-23 18:07:44 +00:00
if ($this->tax_status=='taxable' && get_option('woocommerce_calc_taxes')=='yes') return true;
2011-08-09 15:16:18 +00:00
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product shipping is taxable.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
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;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Get the product's post data.
*
* @access public
* @return object
*/
2011-08-09 15:16:18 +00:00
function get_post_data() {
if (empty($this->post)) :
$this->post = get_post( $this->id );
endif;
return $this->post;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Get the title of the post.
*
* @access public
* @return string
*/
2011-08-30 11:24:28 +00:00
function get_title() {
2011-08-09 15:16:18 +00:00
$this->get_post_data();
2012-09-05 19:40:09 +00:00
return apply_filters('woocommerce_product_title', apply_filters( 'the_title', $this->post->post_title, $this->id ), $this);
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Get the parent of the post.
*
* @access public
* @return int
*/
function get_parent() {
$this->get_post_data();
return apply_filters('woocommerce_product_parent', $this->post->post_parent, $this);
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Get the add to url.
*
* @access public
* @return string
*/
2011-08-09 15:16:18 +00:00
function add_to_cart_url() {
return apply_filters( 'woocommerce_add_to_cart_url', add_query_arg( 'add-to-cart', $this->id ) );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product is stock managed.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
function managing_stock() {
if ( ! isset( $this->manage_stock ) || $this->manage_stock == 'no' ) return false;
if ( get_option('woocommerce_manage_stock') == 'yes' ) return true;
2011-08-09 15:16:18 +00:00
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product is in stock.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
function is_in_stock() {
2012-07-17 18:11:14 +00:00
if ( $this->managing_stock() ) :
if ( ! $this->backorders_allowed() ) :
if ( $this->get_total_stock() < 1 ) :
2011-08-09 15:16:18 +00:00
return false;
else :
2012-07-17 18:11:14 +00:00
if ( $this->stock_status == 'instock' ) return true;
2011-08-09 15:16:18 +00:00
return false;
endif;
else :
2012-07-17 18:11:14 +00:00
return true;
2011-08-09 15:16:18 +00:00
endif;
endif;
2012-07-17 18:11:14 +00:00
if ( $this->stock_status == 'instock' ) return true;
2011-08-18 23:14:35 +00:00
return false;
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product can be backordered.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
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;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product needs to notify the customer on backorder.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
function backorders_require_notification() {
if ($this->managing_stock() && $this->backorders=='notify') return true;
2011-08-09 15:16:18 +00:00
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2012-07-17 18:11:14 +00:00
/**
* is_on_backorder function.
2012-08-15 17:08:42 +00:00
*
* @access public
* @param int $qty_in_cart (default: 0)
* @return bool
2012-07-17 18:11:14 +00:00
*/
function is_on_backorder( $qty_in_cart = 0 ) {
if ( $this->managing_stock() && $this->backorders_allowed() && ( $this->get_total_stock() - $qty_in_cart ) < 0 ) return true;
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
2011-08-22 14:10:22 +00:00
* Returns number of items available for sale.
2012-08-06 23:33:52 +00:00
*
2012-08-15 17:08:42 +00:00
* @access public
2011-08-22 14:10:22 +00:00
* @return int
*/
function get_stock_quantity() {
if ( get_option( 'woocommerce_manage_stock' ) == 'no' )
return '';
2011-11-13 19:01:10 +00:00
return (int) $this->stock;
2011-08-22 14:10:22 +00:00
}
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product has enough stock for the order.
*
* @access public
* @param mixed $quantity
* @return bool
*/
2011-08-09 15:16:18 +00:00
function has_enough_stock( $quantity ) {
2012-08-06 23:33:52 +00:00
2011-08-30 11:24:28 +00:00
if (!$this->managing_stock()) return true;
2011-08-09 15:16:18 +00:00
if ($this->backorders_allowed()) return true;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
if ($this->stock >= $quantity) :
return true;
endif;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
return false;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the availability of the product.
*
* @access public
* @return string
*/
2011-08-09 15:16:18 +00:00
function get_availability() {
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
$availability = "";
$class = "";
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
if (!$this->managing_stock()) :
2012-02-13 13:06:56 +00:00
if (!$this->is_in_stock()) :
2012-01-05 11:31:22 +00:00
$availability = __('Out of stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock';
endif;
else :
if ($this->is_in_stock()) :
if ( $this->get_total_stock() > 0 ) :
2012-08-06 23:33:52 +00:00
$format_option = get_option( 'woocommerce_stock_format' );
2012-08-06 23:33:52 +00:00
switch ( $format_option ) {
case 'no_amount' :
$format = __('In stock', 'woocommerce');
break;
case 'low_amount' :
$low_amount = get_option( 'woocommerce_notify_low_stock_amount' );
2012-08-06 23:33:52 +00:00
$format = ( $this->get_total_stock() <= $low_amount ) ? __('Only %s left in stock', 'woocommerce') : __('In stock', 'woocommerce');
break;
default :
$format = __('%s in stock', 'woocommerce');
break;
}
2012-08-06 23:33:52 +00:00
$availability = sprintf( $format, $this->stock );
2012-08-06 23:33:52 +00:00
if ($this->backorders_allowed() && $this->backorders_require_notification()) :
2012-02-13 13:06:56 +00:00
$availability .= ' ' . __('(backorders allowed)', 'woocommerce');
2011-08-09 15:16:18 +00:00
endif;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
else :
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
if ($this->backorders_allowed()) :
if ($this->backorders_require_notification()) :
2012-01-05 11:31:22 +00:00
$availability = __('Available on backorder', 'woocommerce');
$class = 'available-on-backorder';
2011-08-09 15:16:18 +00:00
else :
2012-01-05 11:31:22 +00:00
$availability = __('In stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
endif;
else :
2012-01-05 11:31:22 +00:00
$availability = __('Out of stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock';
endif;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
endif;
else :
if ($this->backorders_allowed()) :
2012-01-05 11:31:22 +00:00
$availability = __('Available on backorder', 'woocommerce');
$class = 'available-on-backorder';
2011-08-09 15:16:18 +00:00
else :
2012-01-05 11:31:22 +00:00
$availability = __('Out of stock', 'woocommerce');
2011-08-09 15:16:18 +00:00
$class = 'out-of-stock';
endif;
endif;
endif;
2012-08-06 23:33:52 +00:00
2012-03-20 17:29:53 +00:00
return apply_filters( 'woocommerce_get_availability', array( 'availability' => $availability, 'class' => $class), $this );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product is featured.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
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
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product is visible.
*
* @access public
* @return bool
*/
2012-01-12 00:54:45 +00:00
function is_visible() {
2012-08-06 23:33:52 +00:00
2012-01-03 15:55:05 +00:00
$visible = true;
2012-08-06 23:33:52 +00:00
2011-08-18 23:14:35 +00:00
// Out of stock visibility
2012-01-03 15:55:05 +00:00
if (get_option('woocommerce_hide_out_of_stock_items')=='yes' && !$this->is_in_stock()) $visible = false;
2012-08-06 23:33:52 +00:00
2011-08-18 23:14:35 +00:00
// visibility setting
2012-01-03 15:55:05 +00:00
elseif ($this->visibility=='hidden') $visible = false;
elseif ($this->visibility=='visible') $visible = true;
2012-08-06 23:33:52 +00:00
2011-11-24 15:32:57 +00:00
// Visibility in loop
2012-01-03 15:55:05 +00:00
elseif ($this->visibility=='search' && is_search()) $visible = true;
elseif ($this->visibility=='search' && !is_search()) $visible = false;
elseif ($this->visibility=='catalog' && is_search()) $visible = false;
elseif ($this->visibility=='catalog' && !is_search()) $visible = true;
2012-08-06 23:33:52 +00:00
return apply_filters('woocommerce_product_is_visible', $visible, $this->id);
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product is on sale.
*
* @access public
* @return bool
*/
2011-08-09 15:16:18 +00:00
function is_on_sale() {
2011-12-09 21:47:12 +00:00
if ($this->has_child()) :
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
foreach ($this->get_children() as $child_id) :
$sale_price = get_post_meta( $child_id, '_sale_price', true );
2012-01-05 16:00:23 +00:00
if ( $sale_price!=="" && $sale_price >= 0 ) return true;
2011-08-09 15:16:18 +00:00
endforeach;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
else :
2012-08-06 23:33:52 +00:00
if ( $this->sale_price && $this->sale_price==$this->price ) return true;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
endif;
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the product's weight.
*
* @access public
* @return string
*/
2011-08-09 15:16:18 +00:00
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
}
2012-07-16 16:23:17 +00:00
2012-08-15 17:08:42 +00:00
/**
* Set a products price dynamically.
*
* @access public
* @param float $price Price to set.
* @return void
*/
2012-07-16 16:23:17 +00:00
function set_price( $price ) {
$this->price = $price;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Adjust a products price dynamically.
*
* @access public
* @param float $price Price to increase by.
* @return void
*/
function adjust_price( $price ) {
2012-07-16 16:23:17 +00:00
if ( $price > 0 ) :
$this->price += $price;
endif;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the product's price.
*
* @access public
* @return string
*/
2011-08-09 15:16:18 +00:00
function get_price() {
2012-04-21 16:38:34 +00:00
return apply_filters( 'woocommerce_get_price', $this->price, $this );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2012-08-06 23:33:52 +00:00
/**
2012-08-15 17:08:42 +00:00
* Returns false if the product cannot be bought.
2012-08-06 23:33:52 +00:00
*
* @access public
2012-08-15 17:08:42 +00:00
* @return cool
2012-08-06 23:33:52 +00:00
*/
function is_purchasable() {
$purchasable = true;
// Products must exist of course
if ( ! $this->exists() )
$purchasable = false;
// External and grouped products cannot be bought
elseif ( $this->is_type( array( 'grouped', 'external' ) ) )
$purchasable = false;
// Other products types need a price to be set
elseif ( $this->get_price() === '' )
$purchasable = false;
return apply_filters( 'woocommerce_is_purchasable', $purchasable, $this );
2012-08-06 23:33:52 +00:00
}
2012-08-15 17:08:42 +00:00
/**
* Returns the price (excluding tax) - ignores tax_class filters since the price may *include* tax and thus needs subtracting.
*
* @access public
* @return string
*/
function get_price_excluding_tax() {
2012-08-06 23:33:52 +00:00
2012-04-21 16:38:34 +00:00
$price = $this->get_price();
2011-08-09 15:16:18 +00:00
2011-12-30 19:36:44 +00:00
if ( $this->is_taxable() && get_option('woocommerce_prices_include_tax')=='yes' ) :
2012-08-06 23:33:52 +00:00
2012-01-27 16:38:39 +00:00
$_tax = new WC_Tax();
2012-08-06 23:33:52 +00:00
$tax_rates = $_tax->get_shop_base_rate( $this->tax_class );
$taxes = $_tax->calc_tax( $price, $tax_rates, true );
$tax_amount = $_tax->get_tax_total( $taxes );
$price = round( $price - $tax_amount, 2);
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
endif;
2012-08-06 23:33:52 +00:00
2012-04-21 16:38:34 +00:00
return apply_filters( 'woocommerce_get_price_excluding_tax', $price, $this );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the tax class.
*
* @access public
* @return string
*/
2011-10-07 22:24:11 +00:00
function get_tax_class() {
return apply_filters('woocommerce_product_tax_class', $this->tax_class, $this);
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the tax status.
*
* @access public
* @return string
*/
2011-12-31 19:03:41 +00:00
function get_tax_status() {
return $this->tax_status;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the price in html format.
*
* @access public
* @param string $price (default: '')
* @return string
*/
function get_price_html( $price = '' ) {
if ($this->is_type('grouped')) :
2012-08-06 23:33:52 +00:00
$child_prices = array();
2012-08-06 23:33:52 +00:00
foreach ($this->get_children() as $child_id) $child_prices[] = get_post_meta( $child_id, '_price', true );
2012-08-06 23:33:52 +00:00
$child_prices = array_unique( $child_prices );
2012-08-06 23:33:52 +00:00
2012-03-06 17:39:53 +00:00
if ( ! empty( $child_prices ) ) {
$min_price = min( $child_prices );
2012-02-27 13:47:18 +00:00
} else {
$min_price = '';
}
2012-08-06 23:33:52 +00:00
if (sizeof($child_prices)>1) $price .= $this->get_price_html_from_text();
2012-08-06 23:33:52 +00:00
$price .= woocommerce_price( $min_price );
2011-09-21 16:58:05 +00:00
$price = apply_filters('woocommerce_grouped_price_html', $price, $this);
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
elseif ($this->is_type('variable')) :
2012-08-06 23:33:52 +00:00
// Ensure variation prices are synced with variations
2012-08-06 23:33:52 +00:00
if ( $this->min_variation_price === '' || $this->min_variation_regular_price === '' )
$this->variable_product_sync();
2012-08-06 23:33:52 +00:00
// Get the price
if ($this->price > 0) :
if ($this->is_on_sale() && isset($this->min_variation_price) && $this->min_variation_regular_price !== $this->get_price()) :
2012-08-06 23:33:52 +00:00
if ( !$this->min_variation_price || $this->min_variation_price !== $this->max_variation_price )
$price .= $this->get_price_html_from_text();
2012-08-06 23:33:52 +00:00
$price .= $this->get_price_html_from_to( $this->min_variation_regular_price, $this->get_price() );
2012-08-06 23:33:52 +00:00
$price = apply_filters('woocommerce_variable_sale_price_html', $price, $this);
else :
2012-08-06 23:33:52 +00:00
if ( ! $this->min_variation_price || $this->min_variation_price !== $this->max_variation_price )
$price .= $this->get_price_html_from_text();
2012-08-06 23:33:52 +00:00
$price .= woocommerce_price( $this->get_price() );
$price = apply_filters('woocommerce_variable_price_html', $price, $this);
endif;
elseif ($this->price === '' ) :
$price = apply_filters('woocommerce_variable_empty_price_html', '', $this);
elseif ($this->price == 0 ) :
2012-08-06 23:33:52 +00:00
if ($this->is_on_sale() && isset($this->min_variation_regular_price) && $this->min_variation_regular_price !== $this->get_price()) :
2012-08-06 23:33:52 +00:00
if ( !$this->min_variation_price || $this->min_variation_price !== $this->max_variation_price )
$price .= $this->get_price_html_from_text();
2012-08-06 23:33:52 +00:00
$price .= $this->get_price_html_from_to( $this->min_variation_regular_price, __('Free!', 'woocommerce') );
2012-08-06 23:33:52 +00:00
$price = apply_filters('woocommerce_variable_free_sale_price_html', $price, $this);
else :
2012-08-06 23:33:52 +00:00
if ( ! $this->min_variation_price || $this->min_variation_price !== $this->max_variation_price )
$price .= $this->get_price_html_from_text();
2012-08-06 23:33:52 +00:00
$price .= __('Free!', 'woocommerce');
$price = apply_filters('woocommerce_variable_free_price_html', $price, $this);
endif;
endif;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
else :
2011-11-22 23:31:44 +00:00
if ($this->price > 0) :
2011-08-17 23:42:07 +00:00
if ($this->is_on_sale() && isset($this->regular_price)) :
2012-08-06 23:33:52 +00:00
$price .= $this->get_price_html_from_to( $this->regular_price, $this->get_price() );
2012-08-06 23:33:52 +00:00
2011-09-21 16:58:05 +00:00
$price = apply_filters('woocommerce_sale_price_html', $price, $this);
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
else :
2012-08-06 23:33:52 +00:00
$price .= woocommerce_price( $this->get_price() );
2012-08-06 23:33:52 +00:00
2011-09-21 16:58:05 +00:00
$price = apply_filters('woocommerce_price_html', $price, $this);
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
endif;
elseif ($this->price === '' ) :
2012-08-06 23:33:52 +00:00
2011-11-05 19:12:51 +00:00
$price = apply_filters('woocommerce_empty_price_html', '', $this);
2012-08-06 23:33:52 +00:00
2011-11-22 23:31:44 +00:00
elseif ($this->price == 0 ) :
2012-08-06 23:33:52 +00:00
2011-11-22 23:31:44 +00:00
if ($this->is_on_sale() && isset($this->regular_price)) :
2012-08-06 23:33:52 +00:00
$price .= $this->get_price_html_from_to( $this->regular_price, __('Free!', 'woocommerce') );
2012-08-06 23:33:52 +00:00
2011-11-22 23:31:44 +00:00
$price = apply_filters('woocommerce_free_sale_price_html', $price, $this);
2012-08-06 23:33:52 +00:00
2011-11-22 23:31:44 +00:00
else :
2012-08-06 23:33:52 +00:00
$price = __('Free!', 'woocommerce');
2011-11-22 23:31:44 +00:00
$price = apply_filters('woocommerce_free_price_html', $price, $this);
2012-08-06 23:33:52 +00:00
2011-11-22 23:31:44 +00:00
endif;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
endif;
endif;
2012-08-06 23:33:52 +00:00
return apply_filters('woocommerce_get_price_html', $price, $this);
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Functions for getting parts of a price, in html, used by get_price_html.
*
* @access public
* @return string
*/
function get_price_html_from_text() {
return '<span class="from">' . _x('From:', 'min_price', 'woocommerce') . ' </span>';
}
2012-08-15 17:08:42 +00:00
/**
* Functions for getting parts of a price, in html, used by get_price_html.
*
* @access public
* @return string
*/
function get_price_html_from_to( $from, $to ) {
return '<del>' . ((is_numeric($from)) ? woocommerce_price( $from ) : $from) . '</del> <ins>' . ((is_numeric($to)) ? woocommerce_price( $to ) : $to) . '</ins>';
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the product rating in html format - ratings are stored in transient cache.
*
* @access public
* @param string $location (default: '')
* @return void
*/
function get_rating_html( $location = '' ) {
2012-08-06 23:33:52 +00:00
if ($location) $location = '_'.$location;
$star_size = apply_filters('woocommerce_star_rating_size'.$location, 16);
2012-03-16 16:39:16 +00:00
if ( false === ( $average_rating = get_transient( 'wc_average_rating_' . $this->id ) ) ) :
2012-08-06 23:33:52 +00:00
global $wpdb;
$count = $wpdb->get_var("
2012-08-06 23:33:52 +00:00
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
");
2012-08-06 23:33:52 +00:00
$ratings = $wpdb->get_var("
2012-08-06 23:33:52 +00:00
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'
");
2012-08-06 23:33:52 +00:00
if ( $count>0 ) :
$average_rating = number_format($ratings / $count, 2);
else :
$average_rating = '';
endif;
2012-08-06 23:33:52 +00:00
2012-03-16 16:39:16 +00:00
set_transient( 'wc_average_rating_' . $this->id, $average_rating );
2012-08-06 23:33:52 +00:00
endif;
if ( $average_rating>0 ) :
2012-01-05 11:31:22 +00:00
return '<div class="star-rating" title="'.sprintf(__('Rated %s out of 5', 'woocommerce'), $average_rating).'"><span style="width:'.($average_rating*$star_size).'px"><span class="rating">'.$average_rating.'</span> '.__('out of 5', 'woocommerce').'</span></div>';
2011-08-28 12:04:05 +00:00
else :
return '';
endif;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the upsell product ids.
*
* @access public
* @return array
*/
2011-08-09 15:16:18 +00:00
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
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the crosssell product ids.
*
* @access public
* @return array
*/
2011-08-09 15:16:18 +00:00
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
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the product categories.
*
* @access public
* @param string $sep (default: ')
* @param mixed '
* @param string $before (default: '')
* @param string $after (default: '')
* @return array
*/
2011-08-09 15:16:18 +00:00
function get_categories( $sep = ', ', $before = '', $after = '' ) {
return get_the_term_list($this->id, 'product_cat', $before, $sep, $after);
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the product tags.
*
* @access public
* @param string $sep (default: ')
* @param mixed '
* @param string $before (default: '')
* @param string $after (default: '')
* @return array
*/
2011-08-09 15:16:18 +00:00
function get_tags( $sep = ', ', $before = '', $after = '' ) {
return get_the_term_list($this->id, 'product_tag', $before, $sep, $after);
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the product shipping class.
*
* @access public
* @return string
*/
2011-12-02 20:48:07 +00:00
function get_shipping_class() {
2012-05-31 10:05:00 +00:00
if ( ! $this->shipping_class ) :
2011-12-02 20:48:07 +00:00
$classes = get_the_terms( $this->id, 'product_shipping_class' );
if ($classes && !is_wp_error($classes)) $this->shipping_class = current($classes)->slug; else $this->shipping_class = '';
2011-12-02 20:48:07 +00:00
endif;
return $this->shipping_class;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the product shipping class ID.
*
* @access public
* @return int
*/
2012-05-31 10:05:00 +00:00
function get_shipping_class_id() {
if ( ! $this->shipping_class_id ) :
$classes = get_the_terms( $this->id, 'product_shipping_class' );
2012-08-06 23:33:52 +00:00
if ( $classes && ! is_wp_error( $classes ) )
$this->shipping_class_id = current( $classes )->term_id;
else
2012-06-03 12:12:08 +00:00
$this->shipping_class_id = 0;
2012-05-31 10:05:00 +00:00
endif;
2012-06-03 12:12:08 +00:00
return (int) $this->shipping_class_id;
2012-05-31 10:05:00 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Get and return related products.
*
* @access public
* @param int $limit (default: 5)
* @return array Array of post IDs
*/
2011-08-09 15:16:18 +00:00
function get_related( $limit = 5 ) {
2011-11-13 12:17:52 +00:00
global $woocommerce;
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
// Related products are found from category and tag
$tags_array = array(0);
$cats_array = array(0);
2012-08-06 23:33:52 +00:00
2011-08-09 15:16:18 +00:00
// 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;
2012-08-06 23:33:52 +00:00
// Get categories
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;
2012-08-06 23:33:52 +00:00
// Don't bother if none are set
if ( sizeof($cats_array)==1 && sizeof($tags_array)==1 ) return array();
2012-08-06 23:33:52 +00:00
2011-11-13 12:17:52 +00:00
// Meta query
$meta_query = array();
$meta_query[] = $woocommerce->query->visibility_meta_query();
$meta_query[] = $woocommerce->query->stock_status_meta_query();
2012-08-06 23:33:52 +00:00
2011-11-13 12:17:52 +00:00
// Get the posts
2012-01-05 16:02:37 +00:00
$related_posts = get_posts(apply_filters('woocommerce_product_related_posts', array(
2011-11-13 12:17:52 +00:00
'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
)
2012-01-05 16:02:37 +00:00
)));
2012-08-06 23:33:52 +00:00
2011-11-17 19:07:25 +00:00
$related_posts = array_diff( $related_posts, array($this->id) );
2012-08-06 23:33:52 +00:00
2011-11-13 12:17:52 +00:00
return $related_posts;
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns a single product attribute.
*
* @access public
* @param mixed $attr
* @return mixed
*/
2011-11-26 20:23:57 +00:00
function get_attribute( $attr ) {
$attributes = $this->get_attributes();
2012-08-06 23:33:52 +00:00
2012-01-10 17:14:40 +00:00
$attr = sanitize_title( $attr );
2012-08-06 23:33:52 +00:00
if ( isset( $attributes[ $attr ] ) || isset( $attributes[ 'pa_' . $attr ] ) ) {
2012-08-06 23:33:52 +00:00
$attribute = isset( $attributes[ $attr ] ) ? $attributes[ $attr ] : $attributes[ 'pa_' . $attr ];
2012-08-06 23:33:52 +00:00
if ( $attribute['is_taxonomy'] ) {
2012-08-06 23:33:52 +00:00
return implode( ', ', woocommerce_get_product_terms( $this->id, $attribute['name'], 'names' ) );
2012-08-06 23:33:52 +00:00
} else {
2012-08-06 23:33:52 +00:00
2012-01-10 17:14:40 +00:00
return $attribute['value'];
2012-08-06 23:33:52 +00:00
}
2012-08-06 23:33:52 +00:00
}
2012-08-06 23:33:52 +00:00
2012-01-10 17:14:40 +00:00
return false;
2011-11-26 20:23:57 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns product attributes.
*
* @access public
* @return array
*/
2011-08-09 15:16:18 +00:00
function get_attributes() {
2012-08-06 23:33:52 +00:00
if ( ! is_array( $this->attributes ) ) {
2012-08-06 23:33:52 +00:00
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();
}
2012-08-06 23:33:52 +00:00
2011-11-13 02:15:00 +00:00
return (array) $this->attributes;
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product has any attributes set.
*
* @access public
* @return mixed
*/
2011-08-09 15:16:18 +00:00
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;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not we are showing dimensions on the product page.
*
* @access public
* @return bool
*/
function enable_dimensions_display() {
if (get_option('woocommerce_enable_dimension_product_attributes')=='yes') return true;
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product has dimensions set.
*
* @access public
* @return bool
*/
function has_dimensions() {
if ($this->get_dimensions()) return true;
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product has weight set.
*
* @access public
* @return bool
*/
function has_weight() {
if ($this->get_weight()) return true;
return false;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns dimensions.
*
* @access public
* @return string
*/
function get_dimensions() {
if (!$this->dimensions) :
$this->dimensions = '';
2012-02-07 13:48:28 +00:00
// Show length
if ($this->length) {
$this->dimensions = $this->length;
2012-02-07 13:48:28 +00:00
// Show width also
if ($this->width) {
$this->dimensions .= ' × '.$this->width;
2012-02-07 13:48:28 +00:00
// Show height also
if ($this->height) {
$this->dimensions .= ' × '.$this->height;
2012-02-07 13:48:28 +00:00
}
}
// Append the unit
$this->dimensions .= ' '.get_option('woocommerce_dimension_unit');
2012-02-07 13:48:28 +00:00
}
endif;
return $this->dimensions;
}
2012-08-15 17:08:42 +00:00
/**
* Lists a table of attributes for the product page.
*
* @access public
* @return void
*/
function list_attributes() {
2012-04-13 17:33:51 +00:00
woocommerce_get_template('single-product/product-attributes.php', array(
'product' => $this
));
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* get_available_attribute_variations Deprecated - naming was confusing.
*
* @deprecated 1.5.7
* @access public
* @return void
*/
function get_available_attribute_variations() {
_deprecated_function( 'get_available_attribute_variations', '1.5.7', 'get_variation_attributes' );
return $this->get_variation_attributes();
}
2012-08-15 17:08:42 +00:00
/**
* Return an array of attributes used for variations, as well as their possible values.
*
* @access public
* @return array of attributes and their available values
*/
function get_variation_attributes() {
2012-08-06 23:33:52 +00:00
$variation_attributes = array();
2012-08-06 23:33:52 +00:00
if ( ! $this->is_type('variable') || ! $this->has_child() )
return $variation_attributes;
2012-08-06 23:33:52 +00:00
2011-08-22 14:10:22 +00:00
$attributes = $this->get_attributes();
2012-08-06 23:33:52 +00:00
foreach ( $attributes as $attribute ) {
2012-08-06 23:33:52 +00:00
if ( ! $attribute['is_variation'] )
continue;
2011-08-22 14:10:22 +00:00
$values = array();
$attribute_field_name = 'attribute_' . sanitize_title( $attribute['name'] );
2011-08-22 14:10:22 +00:00
foreach ( $this->get_children() as $child_id ) {
2012-08-06 23:33:52 +00:00
if ( get_post_status( $child_id ) != 'publish' )
continue; // Disabled
2012-08-06 23:33:52 +00:00
2011-11-13 12:07:29 +00:00
$child = $this->get_child( $child_id );
2012-08-06 23:33:52 +00:00
$child_variation_attributes = $child->get_variation_attributes();
2011-08-22 14:10:22 +00:00
foreach ( $child_variation_attributes as $name => $value )
2012-08-06 23:33:52 +00:00
if ( $name == $attribute_field_name )
$values[] = $value;
2011-08-22 14:10:22 +00:00
}
2011-11-22 16:13:32 +00:00
2011-08-22 14:10:22 +00:00
// empty value indicates that all options for given attribute are available
if ( in_array( '', $values ) ) {
2012-08-06 23:33:52 +00:00
$values = array();
2012-08-06 23:33:52 +00:00
// Get all options
if ( $attribute['is_taxonomy'] ) {
$post_terms = wp_get_post_terms( $this->id, $attribute['name'] );
foreach ( $post_terms as $term )
$values[] = $term->slug;
} else {
$values = explode( '|', $attribute['value'] );
}
2012-08-06 23:33:52 +00:00
$values = array_unique( array_map( 'trim', $values ) );
2012-08-06 23:33:52 +00:00
// Order custom attributes (non taxonomy) as defined
2011-11-22 16:13:32 +00:00
} else {
2012-08-06 23:33:52 +00:00
if ( ! $attribute['is_taxonomy'] ) {
$options = array_map( 'trim', explode( '|', $attribute['value'] ) );
$values = array_intersect( $options, $values );
}
2012-08-06 23:33:52 +00:00
2011-08-22 14:10:22 +00:00
}
2012-08-06 23:33:52 +00:00
$variation_attributes[ $attribute['name'] ] = array_unique( $values );
2011-08-22 14:10:22 +00:00
}
2012-08-06 23:33:52 +00:00
return $variation_attributes;
}
2012-08-06 23:33:52 +00:00
/**
* If set, get the default attributes for a variable product.
2012-08-06 23:33:52 +00:00
*
* @access public
* @return array
*/
function get_variation_default_attributes() {
2012-08-06 23:33:52 +00:00
$default = isset( $this->product_custom_fields['_default_attributes'][0] ) ? $this->product_custom_fields['_default_attributes'][0] : '';
2012-08-06 23:33:52 +00:00
return apply_filters( 'woocommerce_product_default_attributes', (array) maybe_unserialize( $default ), $this );
}
2012-08-06 23:33:52 +00:00
/**
* Get an array of available variations for the current product.
2012-08-06 23:33:52 +00:00
*
* @access public
* @return array
*/
function get_available_variations() {
$available_variations = array();
foreach ( $this->get_children() as $child_id ) {
$variation = $this->get_child( $child_id );
if ( $variation instanceof WC_Product_Variation ) {
2012-08-06 23:33:52 +00:00
if ( get_post_status( $variation->get_variation_id() ) != 'publish' || ! $variation->is_visible() )
continue; // Disabled or hidden
$variation_attributes = $variation->get_variation_attributes();
$availability = $variation->get_availability();
$availability_html = empty( $availability['availability'] ) ? '' : apply_filters( 'woocommerce_stock_html', '<p class="stock ' . $availability['class'] . '">'. $availability['availability'].'</p>', $availability['availability'] );
if ( has_post_thumbnail( $variation->get_variation_id() ) ) {
$attachment_id = get_post_thumbnail_id( $variation->get_variation_id() );
2012-08-06 23:33:52 +00:00
2012-07-17 14:21:48 +00:00
$attachment = wp_get_attachment_image_src( $attachment_id, apply_filters( 'single_product_large_thumbnail_size', 'shop_single' ) );
$image = $attachment ? current( $attachment ) : '';
2012-08-06 23:33:52 +00:00
2012-07-17 14:21:48 +00:00
$attachment = wp_get_attachment_image_src( $attachment_id, 'full' );
$image_link = $attachment ? current( $attachment ) : '';
2012-08-10 15:56:13 +00:00
$image_title = get_the_title( $attachment_id );
} else {
$image = $image_link = $image_title = '';
}
$available_variations[] = apply_filters( 'woocommerce_available_variation', array(
'variation_id' => $child_id,
'attributes' => $variation_attributes,
'image_src' => $image,
'image_link' => $image_link,
'image_title' => $image_title,
'price_html' => $this->min_variation_price != $this->max_variation_price ? '<span class="price">' . $variation->get_price_html() . '</span>' : '',
'availability_html' => $availability_html,
'sku' => __( 'SKU:', 'woocommerce' ) . ' ' . $variation->get_sku(),
'min_qty' => 1,
'max_qty' => $this->backorders_allowed() ? '' : $variation->stock,
'backorders_allowed' => $this->backorders_allowed(),
'is_in_stock' => $variation->is_in_stock(),
'is_downloadable' => $variation->is_downloadable() ,
'is_virtual' => $variation->is_virtual(),
'is_sold_individually' => $variation->is_sold_individually() ? 'yes' : 'no',
), $this, $variation );
}
}
2012-08-06 23:33:52 +00:00
return $available_variations;
2011-08-22 14:10:22 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns the main product image
2012-08-15 17:08:42 +00:00
*
* @access public
* @param string $size (default: 'shop_thumbnail')
* @return string
2012-08-06 23:33:52 +00:00
*/
function get_image( $size = 'shop_thumbnail' ) {
global $woocommerce;
2012-08-06 23:33:52 +00:00
$image = '';
2012-08-06 23:33:52 +00:00
2012-06-29 16:51:15 +00:00
if ( has_post_thumbnail( $this->id ) ) {
2012-08-06 23:33:52 +00:00
$image = get_the_post_thumbnail( $this->id, $size );
2012-06-29 16:51:15 +00:00
} elseif ( ( $parent_id = wp_get_post_parent_id( $this->id ) ) && has_post_thumbnail( $parent_id ) ) {
2012-08-06 23:33:52 +00:00
$image = get_the_post_thumbnail( $parent_id, $size );
2012-06-29 16:51:15 +00:00
} else {
2012-08-06 23:33:52 +00:00
$image = '<img src="' . woocommerce_placeholder_img_src() . '" alt="Placeholder" width="' . $woocommerce->get_image_size( 'shop_thumbnail_image_width' ) . '" height="' . $woocommerce->get_image_size( 'shop_thumbnail_image_height' ) . '" />';
2012-06-29 16:51:15 +00:00
}
2012-08-06 23:33:52 +00:00
return $image;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
2011-09-03 22:37:16 +00:00
/**
2012-08-15 17:08:42 +00:00
* Checks sale data to see if the product is due to go on sale/sale has expired, and updates the main price.
*
* @access public
* @return void
2012-08-06 23:33:52 +00:00
*/
2011-09-03 22:37:16 +00:00
function check_sale_price() {
2012-08-06 23:33:52 +00:00
if ( $this->sale_price_dates_from && $this->sale_price_dates_from < current_time('timestamp') ) {
2012-08-06 23:33:52 +00:00
if ( $this->sale_price && $this->price !== $this->sale_price ) {
2012-08-06 23:33:52 +00:00
// Update price
2011-09-03 22:37:16 +00:00
$this->price = $this->sale_price;
update_post_meta( $this->id, '_price', $this->price );
2012-08-06 23:33:52 +00:00
// Grouped product prices and sale status are affected by children
$this->grouped_product_sync();
}
2011-09-03 22:37:16 +00:00
}
2012-08-06 23:33:52 +00:00
if ( $this->sale_price_dates_to && $this->sale_price_dates_to < current_time('timestamp') ) {
2012-08-06 23:33:52 +00:00
if ( $this->regular_price && $this->price !== $this->regular_price ) {
2012-08-06 23:33:52 +00:00
2011-09-03 22:37:16 +00:00
$this->price = $this->regular_price;
update_post_meta( $this->id, '_price', $this->price );
2012-08-06 23:33:52 +00:00
2011-09-03 22:37:16 +00:00
// Sale has expired - clear the schedule boxes
update_post_meta( $this->id, '_sale_price', '' );
update_post_meta( $this->id, '_sale_price_dates_from', '' );
update_post_meta( $this->id, '_sale_price_dates_to', '' );
2012-08-06 23:33:52 +00:00
// Grouped product prices and sale status are affected by children
2012-08-06 23:33:52 +00:00
$this->grouped_product_sync();
}
2012-08-06 23:33:52 +00:00
}
2011-09-03 22:37:16 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Sync grouped products with the childs lowest price (so they can be sorted by price accurately).
*
* @access public
* @return void
*/
function grouped_product_sync() {
global $wpdb, $woocommerce;
2011-09-03 22:37:16 +00:00
$post_parent = $wpdb->get_var("SELECT post_parent FROM $wpdb->posts WHERE ID = $this->id;");
2012-08-06 23:33:52 +00:00
2011-09-03 22:37:16 +00:00
if (!$post_parent) return;
2012-08-06 23:33:52 +00:00
2011-09-03 22:37:16 +00:00
$children_by_price = get_posts( array(
'post_parent' => $post_parent,
'orderby' => 'meta_value_num',
'order' => 'asc',
2011-12-24 17:09:43 +00:00
'meta_key' => '_price',
2011-09-03 22:37:16 +00:00
'posts_per_page' => 1,
'post_type' => 'product',
'fields' => 'ids'
2011-09-03 22:37:16 +00:00
));
if ($children_by_price) :
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;
2012-08-06 23:33:52 +00:00
$woocommerce->clear_product_transients( $this->id );
2011-09-03 22:37:16 +00:00
}
2011-08-09 15:16:18 +00:00
2012-08-15 17:08:42 +00:00
/**
* Sync variable product prices with the childs lowest/highest prices.
*
* @access public
* @return void
*/
function variable_product_sync() {
global $woocommerce;
2012-08-06 23:33:52 +00:00
$children = get_posts( array(
'post_parent' => $this->id,
'posts_per_page'=> -1,
'post_type' => 'product_variation',
'fields' => 'ids',
'post_status' => 'publish'
));
2012-08-06 23:33:52 +00:00
$this->min_variation_price = $this->min_variation_regular_price = $this->min_variation_sale_price = $this->max_variation_price = $this->max_variation_regular_price = $this->max_variation_sale_price = '';
2012-08-06 23:33:52 +00:00
if ($children) {
foreach ( $children as $child ) {
2012-08-06 23:33:52 +00:00
$child_price = get_post_meta($child, '_price', true);
$child_sale_price = get_post_meta($child, '_sale_price', true);
2012-08-06 23:33:52 +00:00
// Low price
if (!is_numeric($this->min_variation_regular_price) || $child_price < $this->min_variation_regular_price) $this->min_variation_regular_price = $child_price;
if ($child_sale_price!=='' && (!is_numeric($this->min_variation_sale_price) || $child_sale_price < $this->min_variation_sale_price)) $this->min_variation_sale_price = $child_sale_price;
2012-08-06 23:33:52 +00:00
// High price
if (!is_numeric($this->max_variation_regular_price) || $child_price > $this->max_variation_regular_price) $this->max_variation_regular_price = $child_price;
if ($child_sale_price!=='' && (!is_numeric($this->max_variation_sale_price) || $child_sale_price > $this->max_variation_sale_price)) $this->max_variation_sale_price = $child_sale_price;
}
2012-08-06 23:33:52 +00:00
$this->min_variation_price = ($this->min_variation_sale_price==='' || $this->min_variation_regular_price < $this->min_variation_sale_price) ? $this->min_variation_regular_price : $this->min_variation_sale_price;
$this->max_variation_price = ($this->max_variation_sale_price==='' || $this->max_variation_regular_price > $this->max_variation_sale_price) ? $this->max_variation_regular_price : $this->max_variation_sale_price;
}
2012-08-06 23:33:52 +00:00
update_post_meta( $this->id, '_price', $this->min_variation_price );
update_post_meta( $this->id, '_min_variation_price', $this->min_variation_price );
update_post_meta( $this->id, '_max_variation_price', $this->max_variation_price );
update_post_meta( $this->id, '_min_variation_regular_price', $this->min_variation_regular_price );
update_post_meta( $this->id, '_max_variation_regular_price', $this->max_variation_regular_price );
update_post_meta( $this->id, '_min_variation_sale_price', $this->min_variation_sale_price );
update_post_meta( $this->id, '_max_variation_sale_price', $this->max_variation_sale_price );
2012-08-06 23:33:52 +00:00
$this->price = $this->min_variation_price;
2012-08-06 23:33:52 +00:00
2012-08-10 15:56:13 +00:00
$woocommerce->clear_product_transients( $this->id );
}
2012-01-27 16:38:39 +00:00
}
2012-08-15 17:08:42 +00:00
/**
* woocommerce_product class.
*
* @extends WC_Product
* @deprecated 1.4
* @package WooCommerce/Classes
*/
2012-01-27 16:38:39 +00:00
class woocommerce_product extends WC_Product {
2012-08-06 23:33:52 +00:00
public function __construct( $id ) {
2012-01-27 16:38:39 +00:00
_deprecated_function( 'woocommerce_product', '1.4', 'WC_Product()' );
2012-08-06 23:33:52 +00:00
parent::__construct( $id );
}
2011-08-09 15:16:18 +00:00
}