id = absint( $product->ID );
$this->post = $product;
} else {
$this->id = absint( $product );
$this->post = get_post( $this->id );
}
$this->product_custom_fields = get_post_custom( $this->id );
}
/**
* Load the data from the custom fields
*
* @access public
* @param mixed $fields
* @param string $data (default: '')
* @return void
*/
function load_product_data( $fields, $data = '' ) {
if ( ! $data )
$data = $this->product_custom_fields;
if ( $fields )
foreach ( $fields as $key => $default )
$this->$key = isset( $data[ '_' . $key ][0] ) && $data[ '_' . $key ][0] !== '' ? $data[ '_' . $key ][0] : $default;
}
/**
* Get SKU (Stock-keeping unit) - product unique ID.
*
* @return string
*/
function get_sku() {
return $this->sku;
}
/**
* Returns number of items available for sale.
*
* @access public
* @return int
*/
function get_stock_quantity() {
return $this->managing_stock() ? apply_filters( 'woocommerce_stock_amount', $this->stock ) : '';
}
/**
* Get total stock.
*
* @access public
* @return int
*/
function get_total_stock() {
return $this->get_stock_quantity();
}
/**
* Reduce stock level of the product.
*
* @access public
* @param int $by (default: 1) Amount to reduce by.
* @return int Stock
*/
function reduce_stock( $by = 1 ) {
global $woocommerce;
if ( $this->managing_stock() ) {
$this->stock = $this->stock - $by;
update_post_meta( $this->id, '_stock', $this->stock );
// Out of stock attribute
if ( $this->managing_stock() && ! $this->backorders_allowed() && $this->get_total_stock() <= 0 )
$this->set_stock_status( 'outofstock' );
$woocommerce->clear_product_transients( $this->id ); // Clear transient
return $this->get_stock_quantity();
}
}
/**
* Increase stock level of the product.
*
* @access public
* @param int $by (default: 1) Amount to increase by
* @return int Stock
*/
function increase_stock( $by = 1 ) {
global $woocommerce;
if ( $this->managing_stock() ) {
$this->stock = $this->stock + $by;
update_post_meta( $this->id, '_stock', $this->stock );
// Out of stock attribute
if ( $this->managing_stock() && ( $this->backorders_allowed() || $this->get_total_stock() > 0 ) )
$this->set_stock_status( 'instock' );
$woocommerce->clear_product_transients( $this->id ); // Clear transient
return $this->get_stock_quantity();
}
}
/**
* set_stock_status function.
*
* @access public
* @return void
*/
function set_stock_status( $status ) {
$status = 'outofstock' ? 'outofstock' : 'instock';
if ( $this->stock_status != $status ) {
update_post_meta( $this->id, '_stock_status', $status );
do_action( 'woocommerce_product_set_stock_status', $this->id, $status );
}
}
/**
* Checks the product type.
*
* Backwards compat with downloadable/virtual.
*
* @access public
* @param mixed $type Array or string of types
* @return bool
*/
function is_type( $type ) {
return ( $this->product_type == $type || ( is_array( $type ) && in_array( $this->product_type, $type ) ) ) ? true : false;
}
/**
* Checks if a product is downloadable
*
* @access public
* @return bool
*/
function is_downloadable() {
return $this->downloadable == 'yes' ? true : false;
}
/**
* 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.
*/
function has_file( $download_id = '' ) {
return ( $this->is_downloadable() && $this->get_file_download_path( $download_id ) ) ? true : false;
}
/**
* 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_paths = isset( $this->product_custom_fields['_file_paths'][0] ) ? $this->product_custom_fields['_file_paths'][0] : '';
$file_paths = apply_filters( 'woocommerce_file_download_paths', $file_paths, $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 ];
} else {
$file_path = '';
}
// allow overriding based on the particular file being requested
return apply_filters( 'woocommerce_file_download_path', $file_path, $this->id, $download_id );
}
/**
* Checks if a product is virtual (has no shipping).
*
* @access public
* @return bool
*/
function is_virtual() {
return $this->virtual == 'yes' ? true : false;
}
/**
* Checks if a product needs shipping.
*
* @access public
* @return bool
*/
function needs_shipping() {
return $this->is_virtual() ? false : true;
}
/**
* Check if a product is sold individually (no quantities)
*
* @access public
* @return bool
*/
function is_sold_individually() {
$return = false;
// Sold individually if downloadable, virtual, and the option is enabled OR if intentionally a singular item
if ( 'yes' == $this->sold_individually || ( $this->is_downloadable() && $this->is_virtual() && get_option('woocommerce_limit_downloadable_product_qty') == 'yes' ) || ( ! $this->backorders_allowed() && $this->get_stock_quantity() == 1 ) ) {
$return = true;
}
return apply_filters( 'woocommerce_is_sold_individually', $return, $this );
}
/**
* get_children function.
*
* @access public
* @return bool
*/
function get_children() {
return array();
}
/**
* Returns whether or not the product has any child product.
*
* @access public
* @return bool
*/
function has_child() {
return false;
}
/**
* Returns whether or not the product post exists.
*
* @access public
* @return bool
*/
function exists() {
return empty( $this->post ) ? false : true;
}
/**
* Returns whether or not the product is taxable.
*
* @access public
* @return bool
*/
function is_taxable() {
return $this->tax_status == 'taxable' && get_option( 'woocommerce_calc_taxes' ) == 'yes' ? true : false;
}
/**
* Returns whether or not the product shipping is taxable.
*
* @access public
* @return bool
*/
function is_shipping_taxable() {
return $this->tax_status=='taxable' || $this->tax_status=='shipping' ? true : false;
}
/**
* Get the title of the post.
*
* @access public
* @return string
*/
function get_title() {
return apply_filters( 'woocommerce_product_title', apply_filters( 'the_title', $this->post->post_title, $this->id ), $this );
}
/**
* Get the parent of the post.
*
* @access public
* @return int
*/
function get_parent() {
return apply_filters('woocommerce_product_parent', $this->post->post_parent, $this);
}
/**
* Get the add to url.
*
* @access public
* @return string
*/
function add_to_cart_url() {
return apply_filters( 'woocommerce_add_to_cart_url', add_query_arg( 'add-to-cart', $this->id ) );
}
/**
* Returns whether or not the product is stock managed.
*
* @access public
* @return bool
*/
function managing_stock() {
return ( ! isset( $this->manage_stock ) || $this->manage_stock == 'no' || get_option('woocommerce_manage_stock') != 'yes' ) ? false : true;
}
/**
* Returns whether or not the product is in stock.
*
* @access public
* @return bool
*/
function is_in_stock() {
if ( $this->managing_stock() ) {
if ( $this->backorders_allowed() ) {
return true;
} else {
if ( $this->get_total_stock() < 1 ) {
return false;
} else {
if ( $this->stock_status == 'instock' )
return true;
else
return false;
}
}
} else {
if ( $this->stock_status == 'instock' )
return true;
else
return false;
}
}
/**
* Returns whether or not the product can be backordered.
*
* @access public
* @return bool
*/
function backorders_allowed() {
return $this->backorders == 'yes' || $this->backorders == 'notify' ? true : false;
}
/**
* Returns whether or not the product needs to notify the customer on backorder.
*
* @access public
* @return bool
*/
function backorders_require_notification() {
return $this->managing_stock() && $this->backorders == 'notify' ? true : false;
}
/**
* is_on_backorder function.
*
* @access public
* @param int $qty_in_cart (default: 0)
* @return bool
*/
function is_on_backorder( $qty_in_cart = 0 ) {
return $this->managing_stock() && $this->backorders_allowed() && ( $this->get_total_stock() - $qty_in_cart ) < 0 ? true : false;
}
/**
* Returns whether or not the product has enough stock for the order.
*
* @access public
* @param mixed $quantity
* @return bool
*/
function has_enough_stock( $quantity ) {
return ! $this->managing_stock() || $this->backorders_allowed() || $this->stock >= $quantity ? true : false;
}
/**
* Returns the availability of the product.
*
* @access public
* @return string
*/
function get_availability() {
$availability = $class = "";
if ( $this->managing_stock() ) {
if ( $this->is_in_stock() ) {
if ( $this->get_total_stock() > 0 ) {
$format_option = get_option( 'woocommerce_stock_format' );
switch ( $format_option ) {
case 'no_amount' :
$format = __( 'In stock', 'woocommerce' );
break;
case 'low_amount' :
$low_amount = get_option( 'woocommerce_notify_low_stock_amount' );
$format = ( $this->get_total_stock() <= $low_amount ) ? __( 'Only %s left in stock', 'woocommerce' ) : __( 'In stock', 'woocommerce' );
break;
default :
$format = __( '%s in stock', 'woocommerce' );
break;
}
$availability = sprintf( $format, $this->stock );
if ( $this->backorders_allowed() && $this->backorders_require_notification() )
$availability .= ' ' . __( '(backorders allowed)', 'woocommerce' );
} else {
if ( $this->backorders_allowed() ) {
if ( $this->backorders_require_notification() ) {
$availability = __( 'Available on backorder', 'woocommerce' );
$class = 'available-on-backorder';
} else {
$availability = __( 'In stock', 'woocommerce' );
}
} else {
$availability = __( 'Out of stock', 'woocommerce' );
$class = 'out-of-stock';
}
}
} elseif ( $this->backorders_allowed() ) {
$availability = __( 'Available on backorder', 'woocommerce' );
$class = 'available-on-backorder';
} else {
$availability = __( 'Out of stock', 'woocommerce' );
$class = 'out-of-stock';
}
} elseif ( ! $this->is_in_stock() ) {
$availability = __( 'Out of stock', 'woocommerce' );
$class = 'out-of-stock';
}
return apply_filters( 'woocommerce_get_availability', array( 'availability' => $availability, 'class' => $class ), $this );
}
/**
* Returns whether or not the product is featured.
*
* @access public
* @return bool
*/
function is_featured() {
return $this->featured == 'yes' ? true : false;
}
/**
* Returns whether or not the product is visible.
*
* @access public
* @return bool
*/
function is_visible() {
$visible = true;
// Out of stock visibility
if ( get_option( 'woocommerce_hide_out_of_stock_items' ) == 'yes' && ! $this->is_in_stock() ) $visible = false;
// visibility setting
elseif ( $this->visibility == 'hidden' ) $visible = false;
elseif ( $this->visibility == 'visible' ) $visible = true;
// Visibility in loop
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;
return apply_filters( 'woocommerce_product_is_visible', $visible, $this->id );
}
/**
* Returns whether or not the product is on sale.
*
* @access public
* @return bool
*/
function is_on_sale() {
return $this->sale_price && $this->sale_price == $this->price ? true : false;
}
/**
* Returns the product's weight.
*
* @access public
* @return string
*/
function get_weight() {
if ( $this->weight ) return $this->weight;
}
/**
* Set a products price dynamically.
*
* @access public
* @param float $price Price to set.
* @return void
*/
function set_price( $price ) {
$this->price = $price;
}
/**
* Adjust a products price dynamically.
*
* @access public
* @param mixed $price
* @return void
*/
function adjust_price( $price ) {
if ( $price > 0 )
$this->price += $price;
else
$this->price = $this->price - $price;
}
/**
* Returns the product's price.
*
* @access public
* @return string
*/
function get_price() {
return apply_filters( 'woocommerce_get_price', $this->price, $this );
}
/**
* Returns false if the product cannot be bought.
*
* @access public
* @return cool
*/
function is_purchasable() {
$purchasable = true;
// Products must exist of course
if ( ! $this->exists() )
$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 );
}
/**
* 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() {
$price = $this->get_price();
if ( $this->is_taxable() && get_option('woocommerce_prices_include_tax') == 'yes' ) {
$_tax = new WC_Tax();
$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);
}
return apply_filters( 'woocommerce_get_price_excluding_tax', $price, $this );
}
/**
* Returns the tax class.
*
* @access public
* @return string
*/
function get_tax_class() {
return apply_filters( 'woocommerce_product_tax_class', $this->tax_class, $this );
}
/**
* Returns the tax status.
*
* @access public
* @return string
*/
function get_tax_status() {
return $this->tax_status;
}
/**
* Returns the price in html format.
*
* @access public
* @param string $price (default: '')
* @return string
*/
function get_price_html( $price = '' ) {
if ( $this->price > 0 ) {
if ( $this->is_on_sale() && isset( $this->regular_price ) ) {
$price .= $this->get_price_html_from_to( $this->regular_price, $this->get_price() );
$price = apply_filters( 'woocommerce_sale_price_html', $price, $this );
} else {
$price .= woocommerce_price( $this->get_price() );
$price = apply_filters( 'woocommerce_price_html', $price, $this );
}
} elseif ( $this->price === '' ) {
$price = apply_filters( 'woocommerce_empty_price_html', '', $this );
} elseif ( $this->price == 0 ) {
if ( $this->is_on_sale() && isset( $this->regular_price ) ) {
$price .= $this->get_price_html_from_to( $this->regular_price, __( 'Free!', 'woocommerce' ) );
$price = apply_filters( 'woocommerce_free_sale_price_html', $price, $this );
} else {
$price = __( 'Free!', 'woocommerce' );
$price = apply_filters( 'woocommerce_free_price_html', $price, $this );
}
}
return apply_filters( 'woocommerce_get_price_html', $price, $this );
}
/**
* 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 '' . _x('From:', 'min_price', 'woocommerce') . ' ';
}
/**
* 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 '' . ( ( is_numeric( $from ) ) ? woocommerce_price( $from ) : $from ) . ' ' . ( ( is_numeric( $to ) ) ? woocommerce_price( $to ) : $to ) . '';
}
/**
* 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 = '' ) {
if ( $location )
$location = '_' . $location;
$star_size = apply_filters( 'woocommerce_star_rating_size' . $location, 16 );
if ( false === ( $average_rating = get_transient( 'wc_average_rating_' . $this->id ) ) ) {
global $wpdb;
$count = $wpdb->get_var( $wpdb->prepare("
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 = %d
AND comment_approved = '1'
AND meta_value > 0
"), $this->id );
$ratings = $wpdb->get_var( $wpdb->prepare("
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 = %d
AND comment_approved = '1'
"), $this->id );
if ( $count > 0 )
$average_rating = number_format($ratings / $count, 2);
else
$average_rating = '';
set_transient( 'wc_average_rating_' . $this->id, $average_rating );
}
if ( $average_rating > 0 )
return '