2011-08-09 15:16:18 +00:00
< ? php
/**
2015-11-03 13:53:50 +00:00
* Abstract 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
*
2016-09-23 07:19:35 +00:00
* @ version 2.7 . 0
* @ package WooCommerce / Abstracts
* @ category Abstract Class
* @ author WooThemes
*/
if ( ! defined ( 'ABSPATH' ) ) {
exit ;
}
include_once ( 'abstract-wc-legacy-product.php' );
/**
* Product Class .
2011-08-09 15:16:18 +00:00
*/
2016-09-23 07:19:35 +00:00
class WC_Product extends WC_Abstract_Legacy_Product {
/**
* Stores customer data .
*
* @ var array
*/
protected $data = array (
'name' => '' ,
'slug' => '' ,
2016-10-17 13:46:46 +00:00
//'permalink' => '',
2016-09-23 07:19:35 +00:00
'date_created' => '' ,
'date_modified' => '' ,
'status' => '' ,
2016-10-17 13:46:46 +00:00
'featured' => false ,
2016-09-23 07:19:35 +00:00
'catalog_visibility' => 'hidden' ,
'description' => '' ,
'short_description' => '' ,
'sku' => '' ,
'regular_price' => '' ,
'sale_price' => '' ,
'date_on_sale_from' => '' ,
'date_on_sale_to' => '' ,
'total_sales' => '' ,
'tax_status' => 'taxable' ,
'tax_class' => '' ,
2016-10-17 13:46:46 +00:00
'manage_stock' => false ,
2016-09-23 07:19:35 +00:00
'stock_quantity' => null ,
'stock_status' => '' ,
'backorders' => 'no' ,
2016-10-17 13:46:46 +00:00
'sold_individually' => false ,
2016-09-23 07:19:35 +00:00
'weight' => '' ,
'length' => '' ,
'width' => '' ,
'height' => '' ,
2016-10-17 13:46:46 +00:00
'upsell_ids' => array (),
'cross_sell_ids' => array (),
2016-09-23 07:19:35 +00:00
'parent_id' => 0 ,
'reviews_allowed' => true ,
'purchase_note' => '' ,
2016-09-29 23:02:50 +00:00
'attributes' => array (),
'default_attributes' => array (),
2016-09-23 07:19:35 +00:00
'menu_order' => 0 ,
);
/**
* Data stored in meta keys , but not considered " meta " .
*
* @ since 2.7 . 0
* @ var array
*/
protected $internal_meta_keys = array ();
/**
* Supported features such as 'ajax_add_to_cart' .
*
* @ var array
*/
protected $supports = array ();
/**
* Get the product if ID is passed , otherwise the product is new and empty .
* This class should NOT be instantiated , but the wc_get_product () function
* should be used . It is possible , but the wc_get_product () is preferred .
*
* @ param int | WC_Product | object $product Product to init .
*/
public function __construct ( $product = 0 ) {
if ( is_numeric ( $product ) && $product > 0 ) {
$this -> read ( $product );
} elseif ( $product instanceof self ) {
$this -> read ( absint ( $product -> get_id () ) );
} elseif ( ! empty ( $product -> ID ) ) {
$this -> read ( absint ( $product -> ID ) );
}
}
2016-10-17 13:46:46 +00:00
/**
* Get internal type .
* @ since 2.7 . 0
* @ return string
*/
public function get_type () {
return 'simple' ;
}
/**
* Product permalink .
* @ return string
*/
public function get_permalink () {
return get_permalink ( $this -> get_id () );
}
2016-09-23 07:19:35 +00:00
/*
|--------------------------------------------------------------------------
| Getters
|--------------------------------------------------------------------------
|
| Methods for getting data from the product object .
*/
/**
* Get product name .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_name () {
return apply_filters ( 'woocommerce_product_get_name' , $this -> data [ 'name' ], $this );
}
/**
* Get product slug .
* @ since 2.7 . 0
* @ return string
*/
public function get_slug () {
return $this -> data [ 'slug' ];
}
/**
* Get product created date .
*
* @ since 2.7 . 0
* @ return string Timestamp .
*/
public function get_date_created () {
return $this -> data [ 'date_created' ];
}
/**
* Get product modified date .
*
* @ since 2.7 . 0
* @ return string Timestamp .
*/
public function get_date_modified () {
return $this -> data [ 'date_modified' ];
}
/**
* Get product status .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_status () {
return $this -> data [ 'status' ];
}
/**
* If the product is featured .
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ return boolean
2016-09-23 07:19:35 +00:00
*/
public function get_featured () {
return $this -> data [ 'featured' ];
}
/**
* Get catalog visibility .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_catalog_visibility () {
return $this -> data [ 'catalog_visibility' ];
}
/**
* Get product description .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_description () {
return $this -> data [ 'description' ];
}
/**
* Get product short description .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_short_description () {
return $this -> data [ 'short_description' ];
}
/**
* Get SKU ( Stock - keeping unit ) - product unique ID .
*
* @ return string
*/
public function get_sku () {
return apply_filters ( 'woocommerce_get_sku' , $this -> data [ 'sku' ], $this );
}
/**
* Returns the product ' s regular price .
*
* @ return string price
*/
public function get_regular_price () {
return apply_filters ( 'woocommerce_get_regular_price' , $this -> data [ 'regular_price' ], $this );
}
/**
* Returns the product ' s sale price .
*
* @ return string price
*/
public function get_sale_price () {
return apply_filters ( 'woocommerce_get_sale_price' , $this -> data [ 'sale_price' ], $this );
}
/**
* Get date on sale from .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_date_on_sale_from () {
return $this -> data [ 'date_on_sale_from' ];
}
/**
* Get date on sale to .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_date_on_sale_to () {
return $this -> data [ 'date_on_sale_to' ];
}
/**
* Get number total of sales .
*
* @ since 2.7 . 0
* @ return int
*/
public function get_total_sales () {
return $this -> data [ 'total_sales' ];
}
/**
* Returns the tax status .
*
* @ return string
*/
public function get_tax_status () {
return $this -> data [ 'tax_status' ];
}
/**
* Returns the tax class .
*
* @ return string
*/
public function get_tax_class () {
return apply_filters ( 'woocommerce_product_tax_class' , $this -> data [ 'tax_class' ], $this );
}
/**
* Return if product manage stock .
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ return boolean
2016-09-23 07:19:35 +00:00
*/
public function get_manage_stock () {
return $this -> data [ 'manage_stock' ];
}
/**
* Returns number of items available for sale .
*
2016-10-17 13:46:46 +00:00
* @ return int | null
2016-09-23 07:19:35 +00:00
*/
public function get_stock_quantity () {
return apply_filters ( 'woocommerce_get_stock_quantity' , $this -> get_manage_stock () ? wc_stock_amount ( $this -> data [ 'stock_quantity' ] ) : null , $this );
}
/**
* Return the stock status .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_stock_status () {
return $this -> data [ 'stock_status' ];
}
/**
* Get backorders .
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ return string yes no or notify
2016-09-23 07:19:35 +00:00
*/
public function get_backorders () {
return $this -> data [ 'backorders' ];
}
/**
* Return if should be sold individually .
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ return boolean
2016-09-23 07:19:35 +00:00
*/
public function get_sold_individually () {
return $this -> data [ 'sold_individually' ];
}
/**
* Returns the product ' s weight .
*
* @ return string
*/
public function get_weight () {
// Legacy filter.
2016-10-17 13:46:46 +00:00
$weight = apply_filters ( 'woocommerce_product_weight' , $this -> data [ 'weight' ], $this ); // @todo standardize these filter names and move BW compat to deprecated class file.
2016-09-23 07:19:35 +00:00
// New filter.
return apply_filters ( 'woocommerce_product_get_weight' , $weight , $this );
}
/**
* Returns the product length .
*
* @ return string
*/
public function get_length () {
// Legacy filter.
$length = apply_filters ( 'woocommerce_product_length' , $this -> data [ 'length' ], $this );
// New filter since 2.7.
2016-09-29 23:02:50 +00:00
return apply_filters ( 'woocommerce_product_get_length' , $length , $this );
2016-09-23 07:19:35 +00:00
}
/**
* Returns the product width .
*
* @ return string
*/
public function get_width () {
// Legacy filter.
2016-09-29 23:02:50 +00:00
$width = apply_filters ( 'woocommerce_product_width' , $this -> data [ 'width' ], $this );
2016-09-23 07:19:35 +00:00
// New filter since 2.7.
2016-09-29 23:02:50 +00:00
return apply_filters ( 'woocommerce_product_get_width' , $width , $this );
2016-09-23 07:19:35 +00:00
}
/**
* Returns the product height .
*
* @ return string
*/
public function get_height () {
// Legacy filter.
2016-09-29 23:02:50 +00:00
$height = apply_filters ( 'woocommerce_product_height' , $this -> data [ 'height' ], $this );
2016-09-23 07:19:35 +00:00
// New filter since 2.7.
2016-09-29 23:02:50 +00:00
return apply_filters ( 'woocommerce_product_get_height' , $height , $this );
2016-09-23 07:19:35 +00:00
}
/**
2016-10-17 13:46:46 +00:00
* Get upsel IDs .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ return array
2016-09-23 07:19:35 +00:00
*/
public function get_upsell_ids () {
2016-09-29 23:02:50 +00:00
return $this -> data [ 'upsell_ids' ];
2016-09-23 07:19:35 +00:00
}
/**
2016-10-17 13:46:46 +00:00
* Get cross sell IDs .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ return array
2016-09-23 07:19:35 +00:00
*/
public function get_cross_sell_ids () {
return $this -> data [ 'cross_sell_ids' ];
}
/**
* Get parent ID .
*
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ return int
2016-09-23 07:19:35 +00:00
*/
public function get_parent_id () {
return $this -> data [ 'parent_id' ];
}
/**
* Return if reviews is allowed .
*
* @ since 2.7 . 0
* @ return bool
*/
public function get_reviews_allowed () {
return $this -> data [ 'reviews_allowed' ];
}
/**
* Get purchase note .
*
* @ since 2.7 . 0
* @ return string
*/
public function get_purchase_note () {
return $this -> data [ 'purchase_note' ];
}
/**
* Returns product attributes .
*
* @ return array
*/
public function get_attributes () {
2016-10-17 13:46:46 +00:00
$attributes = $this -> data [ 'product_attributes' ];
2016-09-23 07:19:35 +00:00
$taxonomies = wp_list_pluck ( wc_get_attribute_taxonomies (), 'attribute_name' );
// Check for any attributes which have been removed globally
foreach ( $attributes as $key => $attribute ) {
if ( $attribute [ 'is_taxonomy' ] ) {
if ( ! in_array ( substr ( $attribute [ 'name' ], 3 ), $taxonomies ) ) {
unset ( $attributes [ $key ] );
}
}
}
return apply_filters ( 'woocommerce_get_product_attributes' , $attributes );
}
/**
* Get default attributes .
*
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ return array
2016-09-23 07:19:35 +00:00
*/
public function get_default_attributes () {
return $this -> data [ 'default_attributes' ];
}
/**
* Get menu order .
*
* @ since 2.7 . 0
* @ return int
*/
public function get_menu_order () {
return $this -> data [ 'menu_order' ];
}
/*
|--------------------------------------------------------------------------
| Setters
|--------------------------------------------------------------------------
|
| Functions for setting product data . These should not update anything in the
| database itself and should only change what is stored in the class
| object .
*/
/**
* Set product name .
*
* @ since 2.7 . 0
* @ param string $name Product name .
*/
public function set_name ( $name ) {
$this -> data [ 'name' ] = $name ;
}
/**
* Set product slug .
*
* @ since 2.7 . 0
* @ param string $slug Product slug .
*/
public function set_slug ( $slug ) {
$this -> data [ 'slug' ] = $slug ;
}
/**
* Set product created date .
*
* @ since 2.7 . 0
* @ param string $timestamp Timestamp .
*/
public function set_date_created ( $timestamp ) {
$this -> data [ 'date_created' ] = is_numeric ( $timestamp ) ? $timestamp : strtotime ( $timestamp );
}
/**
2016-09-29 23:02:50 +00:00
* Set product modified date .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
* @ param string $timestamp Timestamp .
*/
public function set_date_modified ( $timestamp ) {
$this -> data [ 'date_modified' ] = is_numeric ( $timestamp ) ? $timestamp : strtotime ( $timestamp );
}
/**
2016-09-29 23:02:50 +00:00
* Set product status .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
* @ param string $status Product status .
*/
public function set_status ( $status ) {
$this -> data [ 'status' ] = $status ;
}
/**
* Set if the product is featured .
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param bool | string
2016-09-23 07:19:35 +00:00
*/
public function set_featured ( $featured ) {
2016-10-17 13:46:46 +00:00
$this -> data [ 'featured' ] = wc_string_to_bool ( $featured );
2016-09-23 07:19:35 +00:00
}
/**
* Set catalog visibility .
*
* @ since 2.7 . 0
* @ throws WC_Data_Exception
* @ param string $visibility Options : 'hidden' , 'visible' , 'search' and 'catalog' .
*/
public function set_catalog_visibility ( $visibility ) {
$options = array_keys ( wc_get_product_visibility_options () );
if ( ! in_array ( $visibility , $options , true ) ) {
$this -> error ( 'product_invalid_catalog_visibility' , __ ( 'Invalid catalog visibility option.' , 'woocommerce' ) );
}
$this -> data [ 'catalog_visibility' ] = $visibility ;
}
/**
* Set product description .
*
* @ since 2.7 . 0
* @ param string $description Product description .
*/
public function set_description ( $description ) {
$this -> data [ 'description' ] = $description ;
}
/**
* Set product short description .
*
* @ since 2.7 . 0
* @ param string $short_description Product short description .
*/
public function set_short_description ( $short_description ) {
$this -> data [ 'short_description' ] = $short_description ;
}
/**
* Set SKU .
*
* @ since 2.7 . 0
* @ throws WC_Data_Exception
* @ param string $sku Product SKU .
*/
public function set_sku ( $sku ) {
2016-09-29 23:16:42 +00:00
if ( ! empty ( $sku ) && ! wc_product_has_unique_sku ( $this -> get_id (), $sku ) ) {
2016-09-23 07:19:35 +00:00
$this -> error ( 'product_invalid_sku' , __ ( 'Invalid or duplicated SKU.' , 'woocommerce' ) );
}
$this -> data [ 'sku' ] = $sku ;
}
/**
* Set the product ' s regular price .
*
* @ since 2.7 . 0
* @ param string $price Regular price .
*/
public function set_regular_price ( $price ) {
2016-10-17 13:46:46 +00:00
$this -> data [ 'regular_price' ] = wc_format_decimal ( $price );
2016-09-23 07:19:35 +00:00
}
/**
* Set the product ' s sale price .
*
* @ since 2.7 . 0
* @ param string $price sale price .
*/
public function set_sale_price ( $price ) {
2016-10-17 13:46:46 +00:00
$this -> data [ 'sale_price' ] = wc_format_decimal ( $price );
2016-09-23 07:19:35 +00:00
}
/**
* Set date on sale from .
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param string $timestamp Sale from date .
2016-09-23 07:19:35 +00:00
*/
2016-10-17 13:46:46 +00:00
public function set_date_on_sale_from ( $timestamp ) {
$this -> data [ 'date_on_sale_from' ] = is_numeric ( $timestamp ) ? $timestamp : strtotime ( $timestamp );
2016-09-23 07:19:35 +00:00
}
/**
* Set date on sale to .
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param string $timestamp Sale to date .
2016-09-23 07:19:35 +00:00
*/
public function set_date_on_sale_to ( $date ) {
2016-10-17 13:46:46 +00:00
return $this -> data [ 'date_on_sale_to' ] = is_numeric ( $timestamp ) ? $timestamp : strtotime ( $timestamp );
2016-09-23 07:19:35 +00:00
}
/**
* Set number total of sales .
*
* @ since 2.7 . 0
* @ param int $total Total of sales .
*/
public function set_total_sales ( $total ) {
$this -> data [ 'total_sales' ] = absint ( $total );
}
/**
* Set the tax status .
*
* @ since 2.7 . 0
* @ throws WC_Data_Exception
* @ param string $status Tax status .
*/
public function set_tax_status ( $status ) {
$options = array (
'taxable' ,
'shipping' ,
'none' ,
);
2016-09-29 23:16:42 +00:00
// Set default if empty.
if ( empty ( $status ) ) {
$status = 'taxable' ;
}
2016-09-23 07:19:35 +00:00
if ( ! in_array ( $status , $options , true ) ) {
$this -> error ( 'product_invalid_tax_status' , __ ( 'Invalid product tax status.' , 'woocommerce' ) );
}
$this -> data [ 'tax_status' ] = $status ;
}
/**
* Set the tax class .
*
* @ since 2.7 . 0
* @ param string $class Tax class .
*/
public function set_tax_class ( $class ) {
$this -> data [ 'tax_class' ] = wc_clean ( $class );
}
/**
2016-09-29 23:02:50 +00:00
* Set if product manage stock .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param bool
2016-09-23 07:19:35 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_manage_stock ( $manage_stock ) {
2016-10-17 13:46:46 +00:00
$this -> data [ 'manage_stock' ] = wc_string_to_bool ( $manage_stock );
2016-09-23 07:19:35 +00:00
}
/**
2016-09-29 23:02:50 +00:00
* Set number of items available for sale .
2016-09-23 07:19:35 +00:00
*
2016-09-29 23:02:50 +00:00
* @ since 2.7 . 0
* @ param float | null $quantity Stock quantity .
2016-09-23 07:19:35 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_stock_quantity ( $quantity ) {
$this -> data [ 'stock_quantity' ] = $quantity ;
2016-09-23 07:19:35 +00:00
}
/**
* Set stock status .
*
* @ param string $status New status .
*/
public function set_stock_status ( $status ) {
$status = 'outofstock' === $status ? 'outofstock' : 'instock' ;
// Sanity check.
if ( $this -> managing_stock () ) {
if ( ! $this -> backorders_allowed () && $this -> get_stock_quantity () <= get_option ( 'woocommerce_notify_no_stock_amount' ) ) {
$status = 'outofstock' ;
}
}
if ( update_post_meta ( $this -> get_id (), '_stock_status' , $status ) ) {
do_action ( 'woocommerce_product_set_stock_status' , $this -> get_id (), $status );
}
2016-09-29 23:16:42 +00:00
$this -> data [ 'stock_status' ] = $status ;
2016-09-23 07:19:35 +00:00
}
/**
2016-09-29 23:02:50 +00:00
* Set backorders .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ param string $backorders Options : 'yes' , 'no' or 'notify' .
2016-09-23 07:19:35 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_backorders ( $backorders ) {
$this -> data [ 'backorders' ] = $backorders ;
2016-09-23 07:19:35 +00:00
}
/**
2016-09-29 23:02:50 +00:00
* Set if should be sold individually .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param bool
2016-09-23 07:19:35 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_sold_individually ( $sold_individually ) {
2016-10-17 13:46:46 +00:00
$this -> data [ 'sold_individually' ] = wc_string_to_bool ( $sold_individually );
2016-09-23 07:19:35 +00:00
}
/**
2016-09-29 23:02:50 +00:00
* Set the product ' s weight .
2016-09-23 07:19:35 +00:00
*
2016-09-29 23:02:50 +00:00
* @ since 2.7 . 0
* @ param float $weigth Total weigth .
2016-09-23 07:19:35 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_weight ( $weight ) {
$this -> data [ 'weight' ] = $weight ;
2016-09-23 07:19:35 +00:00
}
2012-08-06 23:33:52 +00:00
2015-02-10 15:01:04 +00:00
/**
2016-09-29 23:02:50 +00:00
* Set the product length .
2015-02-10 15:01:04 +00:00
*
2016-09-29 23:02:50 +00:00
* @ since 2.7 . 0
* @ param float $weigth Total weigth .
2015-02-10 15:01:04 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_length ( $length ) {
$this -> data [ 'length' ] = $length ;
2016-09-23 07:19:35 +00:00
}
2012-08-15 17:08:42 +00:00
2015-01-20 13:00:56 +00:00
/**
2016-09-29 23:02:50 +00:00
* Set the product width .
2015-02-10 15:01:04 +00:00
*
2016-09-29 23:02:50 +00:00
* @ since 2.7 . 0
* @ param float $width Total width .
2015-02-10 15:01:04 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_width ( $width ) {
$this -> data [ 'width' ] = $width ;
2016-09-23 07:19:35 +00:00
}
2012-08-15 17:08:42 +00:00
2015-02-10 15:01:04 +00:00
/**
2016-09-29 23:02:50 +00:00
* Set the product height .
2015-02-10 15:01:04 +00:00
*
2016-09-29 23:02:50 +00:00
* @ since 2.7 . 0
* @ param float $height Total height .
2015-02-10 15:01:04 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_height ( $height ) {
$this -> data [ 'height' ] = $height ;
2016-09-23 07:19:35 +00:00
}
2012-11-21 18:07:45 +00:00
2015-02-10 15:01:04 +00:00
/**
2016-10-17 13:46:46 +00:00
* Set upsell IDs .
2015-02-10 15:01:04 +00:00
*
2016-09-23 07:19:35 +00:00
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ param string $upsell_ids IDs from the up - sell products .
2015-02-10 15:01:04 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_upsell_ids ( $upsell_ids ) {
2016-10-17 13:46:46 +00:00
$this -> data [ 'upsell_ids' ] = array_filter ( ( array ) $upsell_ids );
2016-09-23 07:19:35 +00:00
}
2015-01-20 13:00:56 +00:00
2015-02-10 15:01:04 +00:00
/**
2016-10-17 13:46:46 +00:00
* Set crosssell IDs .
2015-02-10 15:01:04 +00:00
*
2016-09-23 07:19:35 +00:00
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ param string $cross_sell_ids IDs from the cross - sell products .
2015-02-10 15:01:04 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_cross_sell_ids ( $cross_sell_ids ) {
2016-10-17 13:46:46 +00:00
$this -> data [ 'cross_sell_ids' ] = array_filter ( ( array ) $cross_sell_ids );
2016-09-23 07:19:35 +00:00
}
2015-01-20 13:00:56 +00:00
2016-09-23 07:19:35 +00:00
/**
2016-09-29 23:02:50 +00:00
* Set parent ID .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ param int $parent_id Product parent ID .
2016-09-23 07:19:35 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_parent_id ( $parent_id ) {
$this -> data [ 'parent_id' ] = absint ( $parent_id );
2016-09-23 07:19:35 +00:00
}
2015-12-02 11:46:51 +00:00
2015-11-02 11:23:50 +00:00
/**
2016-09-29 23:02:50 +00:00
* Set if reviews is allowed .
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ param bool $reviews_allowed Reviews allowed or not .
2015-11-02 11:23:50 +00:00
*/
2016-09-29 23:02:50 +00:00
public function set_reviews_allowed ( $reviews_allowed ) {
2016-10-17 13:46:46 +00:00
$this -> data [ 'reviews_allowed' ] = wc_string_to_bool ( $reviews_allowed );
2016-09-23 07:19:35 +00:00
}
2015-11-02 11:23:50 +00:00
2011-08-09 15:16:18 +00:00
/**
2016-09-29 23:02:50 +00:00
* Set purchase note .
2012-11-27 16:22:47 +00:00
*
2016-09-23 07:19:35 +00:00
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ param string $purchase_note Purchase note .
2011-08-09 15:16:18 +00:00
*/
2016-09-29 23:16:42 +00:00
public function set_purchase_note ( $purchase_note ) {
2016-09-29 23:02:50 +00:00
$this -> data [ 'purchase_note' ] = $purchase_note ;
2011-08-09 15:16:18 +00:00
}
2012-11-27 16:22:47 +00:00
2012-12-19 23:04:25 +00:00
/**
2016-10-17 13:46:46 +00:00
* Returns product attributes .
2012-12-19 23:04:25 +00:00
*
2016-09-29 23:02:50 +00:00
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param array $attributes List of product attributes .
2016-09-23 07:19:35 +00:00
*/
2016-10-17 13:46:46 +00:00
public function set_attributes ( $attributes ) {
$this -> data [ 'product_attributes' ] = $attributes ; // @todo ensure unserialised, array, and filtered out empty values
2016-09-23 07:19:35 +00:00
}
/**
2016-10-17 13:46:46 +00:00
* Set default attributes .
2016-09-23 07:19:35 +00:00
*
2016-09-29 23:02:50 +00:00
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param array $default_attributes List of default attributes .
2012-12-19 23:04:25 +00:00
*/
2016-10-17 13:46:46 +00:00
public function set_default_attributes ( $default_attributes ) {
$this -> data [ 'default_attributes' ] = $default_attributes ;
2012-12-19 23:04:25 +00:00
}
2012-11-27 16:22:47 +00:00
2012-11-21 18:07:45 +00:00
/**
2016-10-17 13:46:46 +00:00
* Set menu order .
2012-11-27 16:22:47 +00:00
*
2016-09-29 23:02:50 +00:00
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param int $menu_order Menu order .
2012-11-21 18:07:45 +00:00
*/
2016-10-17 13:46:46 +00:00
public function set_menu_order ( $menu_order ) {
$this -> data [ 'menu_order' ] = intval ( $menu_order );
}
/**
* Returns the product categories . @ todo store in class and save ?
*
* @ param string $sep ( default : ', ' ) .
* @ param string $before ( default : '' ) .
* @ param string $after ( default : '' ) .
* @ return string
*/
public function get_categories ( $sep = ', ' , $before = '' , $after = '' ) {
return get_the_term_list ( $this -> get_id (), 'product_cat' , $before , $sep , $after );
2016-09-23 07:19:35 +00:00
}
2012-12-20 11:54:38 +00:00
2016-09-23 07:19:35 +00:00
/**
2016-10-17 13:46:46 +00:00
* Returns the product tags . @ todo store in class and save ?
*
* @ param string $sep ( default : ', ' ) .
* @ param string $before ( default : '' ) .
* @ param string $after ( default : '' ) .
* @ return array
*/
public function get_tags ( $sep = ', ' , $before = '' , $after = '' ) {
return get_the_term_list ( $this -> get_id (), 'product_tag' , $before , $sep , $after );
}
/**
* Set the product categories . @ todo store in class and save ?
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param array $terms_id List of terms IDs .
2016-09-23 07:19:35 +00:00
*/
2016-10-17 13:46:46 +00:00
public function set_categories ( $terms_id ) {
$this -> save_taxonomy_terms ( $terms_id , 'cat' );
2016-09-23 07:19:35 +00:00
}
2012-12-20 11:54:38 +00:00
2016-09-23 07:19:35 +00:00
/**
2016-10-17 13:46:46 +00:00
* Set the product tags . @ todo store in class and save ?
2016-09-23 07:19:35 +00:00
*
* @ since 2.7 . 0
2016-10-17 13:46:46 +00:00
* @ param array $terms_id List of terms IDs .
2016-09-23 07:19:35 +00:00
*/
2016-10-17 13:46:46 +00:00
public function set_tags ( $terms_id ) {
$this -> save_taxonomy_terms ( $terms_id , 'tag' );
2016-09-23 07:19:35 +00:00
}
2012-12-20 11:54:38 +00:00
2016-10-17 13:46:46 +00:00
2016-09-23 07:19:35 +00:00
/*
|--------------------------------------------------------------------------
| CRUD methods
|--------------------------------------------------------------------------
|
| Methods which create , read , update and delete products from the database .
|
| A save method is included for convenience ( chooses update or create based
| on if the order exists yet ) .
*/
2012-12-20 11:54:38 +00:00
2016-09-23 07:19:35 +00:00
/**
* Reads a product from the database and sets its data to the class .
*
* @ since 2.7 . 0
2016-09-29 23:02:50 +00:00
* @ param int $id Product ID .
2016-09-23 07:19:35 +00:00
*/
public function read ( $id ) {
$this -> set_defaults ();
2012-11-29 16:48:40 +00:00
2016-09-23 07:19:35 +00:00
if ( ! $id || ! ( $post_object = get_post ( $id ) ) ) {
return ;
2013-11-24 10:42:36 +00:00
}
2012-11-29 16:48:40 +00:00
2016-09-23 07:19:35 +00:00
$this -> set_id ( $id );
$this -> set_props ( array (
'name' => get_the_title ( $post_object ),
'slug' => $post_object -> post_name ,
'permalink' => get_permalink ( $post_object ),
'date_created' => $post_object -> post_date ,
'date_modified' => $post_object -> post_modified ,
'type' => '' ,
'status' => $post_object -> post_status ,
'featured' => get_post_meta ( $id , '_featured' , true ),
'catalog_visibility' => 'hidden' ,
'description' => $post_object -> post_content ,
'short_description' => $post_object -> post_excerpt ,
'sku' => get_post_meta ( $id , '_sku' , true ),
'regular_price' => get_post_meta ( $id , '_regular_price' , true ),
'sale_price' => get_post_meta ( $id , '_sale_price' , true ),
'date_on_sale_from' => get_post_meta ( $id , '_sale_price_dates_from' , true ),
'date_on_sale_to' => get_post_meta ( $id , '_sale_price_dates_to' , true ),
'total_sales' => get_post_meta ( $id , 'total_sales' , true ),
'tax_status' => get_post_meta ( $id , '_tax_status' , true ),
'tax_class' => get_post_meta ( $id , '_tax_class' , true ),
'manage_stock' => 'no' ,
'stock_quantity' => get_post_meta ( $id , '_stock' , true ),
'stock_status' => get_post_meta ( $id , '_stock_status' , true ),
'backorders' => get_post_meta ( $id , '_backorders' , true ),
'sold_individually' => get_post_meta ( $id , '_sold_individually' , true ),
'weight' => get_post_meta ( $id , '_weight' , true ),
'length' => get_post_meta ( $id , '_length' , true ),
'width' => get_post_meta ( $id , '_width' , true ),
'height' => get_post_meta ( $id , '_height' , true ),
'upsell_ids' => get_post_meta ( $id , '_upsell_ids' , true ),
'cross_sell_ids' => get_post_meta ( $id , '_crosssell_ids' , true ),
'parent_id' => $post_object -> post_parent ,
'reviews_allowed' => $post_object -> comment_status ,
'purchase_note' => get_post_meta ( $id , '_purchase_note' , true ),
'attributes' => get_post_meta ( $id , '_attributes' , true ),
'default_attributes' => get_post_meta ( $id , '_default_attributes' , true ),
'menu_order' => $post_object -> menu_order ,
) );
$this -> read_meta_data ();
2015-01-23 23:01:10 +00:00
2016-09-23 07:19:35 +00:00
do_action ( 'woocommerce_product_loaded' , $this );
2012-11-21 18:07:45 +00:00
}
2012-11-27 16:22:47 +00:00
2013-01-11 18:30:05 +00:00
/**
2016-09-23 07:19:35 +00:00
* Create a new product .
2013-01-11 18:30:05 +00:00
*
2016-09-23 07:19:35 +00:00
* @ since 2.7 . 0
2013-01-11 18:30:05 +00:00
*/
2016-09-23 07:19:35 +00:00
public function create () {
$this -> set_date_created ( current_time ( 'timestamp' ) );
$id = wp_insert_post ( apply_filters ( 'woocommerce_new_product_data' , array (
'post_type' => 'product' ,
'post_status' => 'publish' ,
'post_author' => get_current_user_id (),
'post_title' => $this -> get_code (),
'post_content' => '' ,
'post_excerpt' => $this -> get_description (),
'post_date' => date ( 'Y-m-d H:i:s' , $this -> get_date_created () ),
'post_date_gmt' => get_gmt_from_date ( date ( 'Y-m-d H:i:s' , $this -> get_date_created () ) ),
) ), true );
if ( $id ) {
$this -> set_id ( $id );
$this -> update_post_meta ( $id );
$this -> save_meta_data ();
do_action ( 'woocommerce_new_product' , $id );
}
2013-01-11 18:30:05 +00:00
}
2015-11-02 11:23:50 +00:00
/**
2016-09-23 07:19:35 +00:00
* Updates an existing product .
2015-11-02 11:23:50 +00:00
*
2016-09-23 07:19:35 +00:00
* @ since 2.7 . 0
2015-11-02 11:23:50 +00:00
*/
2016-09-23 07:19:35 +00:00
public function update () {
2015-11-02 11:23:50 +00:00
}
2015-12-04 20:17:25 +00:00
/**
2016-09-23 07:19:35 +00:00
* Save data ( either create or update depending on if we are working on an existing product ) .
2015-12-04 20:17:25 +00:00
*
2016-09-23 07:19:35 +00:00
* @ since 2.7 . 0
2015-12-04 20:17:25 +00:00
*/
2016-09-23 07:19:35 +00:00
public function save () {
if ( $this -> get_id () ) {
$this -> update ();
} else {
$this -> create ();
}
2015-12-04 20:17:25 +00:00
}
2012-12-20 01:13:06 +00:00
/**
2016-09-23 07:19:35 +00:00
* Delete product from the database .
2012-12-20 01:13:06 +00:00
*
2016-09-23 07:19:35 +00:00
* @ since 2.7 . 0
2012-12-20 01:13:06 +00:00
*/
2016-09-23 07:19:35 +00:00
public function delete () {
wp_delete_post ( $this -> get_id () );
do_action ( 'woocommerce_delete_product' , $this -> get_id () );
$this -> set_id ( 0 );
2012-12-20 01:13:06 +00:00
}
2013-09-23 14:47:47 +00:00
/**
2016-09-23 07:19:35 +00:00
* Helper method that updates all the post meta for a product based on it ' s settings in the WC_Product class .
2014-08-31 05:49:58 +00:00
*
2016-09-23 07:19:35 +00:00
* @ since 2.7 . 0
* @ param int $id Object ID .
2013-09-23 14:47:47 +00:00
*/
2016-09-23 07:19:35 +00:00
private function update_post_meta ( $id ) {
// update_post_meta( $id, 'discount_type', $this->get_discount_type() );
2013-09-23 14:47:47 +00:00
}
2016-09-23 07:19:35 +00:00
/*
|--------------------------------------------------------------------------
| Other Actions
|--------------------------------------------------------------------------
*/
2011-08-22 14:10:22 +00:00
/**
2016-09-23 07:19:35 +00:00
* Check if a product supports a given feature .
2014-02-07 17:31:25 +00:00
*
2016-09-23 07:19:35 +00:00
* Product classes should override this to declare support ( or lack of support ) for a feature .
*
* @ param string $feature string The name of a feature to test support for .
* @ return bool True if the product supports the feature , false otherwise .
* @ since 2.5 . 0
2014-02-07 17:31:25 +00:00
*/
2016-09-23 07:19:35 +00:00
public function supports ( $feature ) {
return apply_filters ( 'woocommerce_product_supports' , in_array ( $feature , $this -> supports ) ? true : false , $feature , $this );
2014-02-07 17:31:25 +00:00
}
/**
2016-09-23 07:19:35 +00:00
* Returns the gallery attachment ids .
2014-02-07 17:31:25 +00:00
*
2016-09-23 07:19:35 +00:00
* @ return array
2014-02-07 17:31:25 +00:00
*/
2016-09-23 07:19:35 +00:00
public function get_gallery_attachment_ids () {
return apply_filters ( 'woocommerce_product_gallery_attachment_ids' , array_filter ( array_filter ( ( array ) explode ( ',' , $this -> product_image_gallery ) ), 'wp_attachment_is_image' ), $this );
2014-02-07 17:31:25 +00:00
}
/**
2016-06-23 10:24:15 +00:00
* Get total stock - This is the stock of parent and children combined .
2015-11-14 16:34:47 +00:00
*
2014-02-07 17:31:25 +00:00
* @ return int
*/
public function get_total_stock () {
2015-11-14 16:34:47 +00:00
if ( empty ( $this -> total_stock ) ) {
if ( sizeof ( $this -> get_children () ) > 0 ) {
2016-01-27 13:00:50 +00:00
$this -> total_stock = max ( 0 , $this -> get_stock_quantity () );
2015-11-14 16:34:47 +00:00
foreach ( $this -> get_children () as $child_id ) {
if ( 'yes' === get_post_meta ( $child_id , '_manage_stock' , true ) ) {
$stock = get_post_meta ( $child_id , '_stock' , true );
$this -> total_stock += max ( 0 , wc_stock_amount ( $stock ) );
}
}
2016-01-27 13:00:50 +00:00
} else {
$this -> total_stock = $this -> get_stock_quantity ();
2015-11-14 16:34:47 +00:00
}
}
return wc_stock_amount ( $this -> total_stock );
2014-02-07 17:31:25 +00:00
}
2012-08-06 23:33:52 +00:00
2012-12-28 09:59:20 +00:00
/**
2015-11-03 12:28:01 +00:00
* Check if the stock status needs changing .
2012-12-28 09:59:20 +00:00
*/
2015-07-27 18:04:08 +00:00
public function check_stock_status () {
2014-04-25 14:27:58 +00:00
if ( ! $this -> backorders_allowed () && $this -> get_total_stock () <= get_option ( 'woocommerce_notify_no_stock_amount' ) ) {
2016-09-07 22:32:24 +00:00
if ( 'outofstock' !== $this -> stock_status ) {
2015-07-27 18:04:08 +00:00
$this -> set_stock_status ( 'outofstock' );
}
2014-04-25 14:27:58 +00:00
} elseif ( $this -> backorders_allowed () || $this -> get_total_stock () > get_option ( 'woocommerce_notify_no_stock_amount' ) ) {
2016-09-07 22:32:24 +00:00
if ( 'instock' !== $this -> stock_status ) {
2015-07-27 18:04:08 +00:00
$this -> set_stock_status ( 'instock' );
}
2014-04-25 14:27:58 +00:00
}
}
2013-08-13 15:56:09 +00:00
2014-04-25 14:27:58 +00:00
/**
* Set stock level of the product .
*
2014-06-24 17:56:33 +00:00
* Uses queries rather than update_post_meta so we can do this in one query ( to avoid stock issues ) .
2014-04-25 14:27:58 +00:00
* We cannot rely on the original loaded value in case another order was made since then .
*
2016-10-12 11:51:40 +00:00
* @ param int $amount ( default : null )
* @ param string $mode can be set , add , or subtract
* @ return int new stock level
2014-04-25 14:27:58 +00:00
*/
public function set_stock ( $amount = null , $mode = 'set' ) {
global $wpdb ;
if ( ! is_null ( $amount ) && $this -> managing_stock () ) {
2014-09-10 22:55:40 +00:00
// Ensure key exists
2016-09-23 07:19:35 +00:00
add_post_meta ( $this -> get_id (), '_stock' , 0 , true );
2014-09-10 22:55:40 +00:00
2014-04-25 14:27:58 +00:00
// Update stock in DB directly
switch ( $mode ) {
case 'add' :
2016-09-23 07:19:35 +00:00
$wpdb -> query ( $wpdb -> prepare ( " UPDATE { $wpdb -> postmeta } SET meta_value = meta_value + %f WHERE post_id = %d AND meta_key='_stock' " , $amount , $this -> get_id () ) );
2014-04-25 14:27:58 +00:00
break ;
case 'subtract' :
2016-09-23 07:19:35 +00:00
$wpdb -> query ( $wpdb -> prepare ( " UPDATE { $wpdb -> postmeta } SET meta_value = meta_value - %f WHERE post_id = %d AND meta_key='_stock' " , $amount , $this -> get_id () ) );
2014-04-25 14:27:58 +00:00
break ;
default :
2016-09-23 07:19:35 +00:00
$wpdb -> query ( $wpdb -> prepare ( " UPDATE { $wpdb -> postmeta } SET meta_value = %f WHERE post_id = %d AND meta_key='_stock' " , $amount , $this -> get_id () ) );
2014-04-25 14:27:58 +00:00
break ;
2013-11-24 10:42:36 +00:00
}
2012-12-28 09:59:20 +00:00
2014-04-25 14:27:58 +00:00
// Clear caches
2016-09-23 07:19:35 +00:00
wp_cache_delete ( $this -> get_id (), 'post_meta' );
2015-03-09 11:07:49 +00:00
delete_transient ( 'wc_low_stock_count' );
delete_transient ( 'wc_outofstock_count' );
2015-02-16 12:14:10 +00:00
unset ( $this -> stock );
2014-04-25 14:27:58 +00:00
// Stock status
$this -> check_stock_status ();
2016-10-12 11:51:40 +00:00
// Trigger action
do_action ( 'woocommerce_product_set_stock' , $this );
// If not managing stock and clearing the stock meta, trigger action to indicate that stock has changed (infinite stock)
} elseif ( '' === $amount && '' !== get_post_meta ( $this -> id , '_stock' , true ) ) {
update_post_meta ( $this -> id , '_stock' , '' );
2013-08-13 15:56:09 +00:00
// Trigger action
do_action ( 'woocommerce_product_set_stock' , $this );
2012-12-28 09:59:20 +00:00
}
2013-11-29 18:50:31 +00:00
2014-04-25 14:27:58 +00:00
return $this -> get_stock_quantity ();
2012-12-28 09:59:20 +00:00
}
2011-08-09 15:16:18 +00:00
/**
2014-06-24 17:56:33 +00:00
* Reduce stock level of the product .
2011-08-09 15:16:18 +00:00
*
2014-08-31 05:49:58 +00:00
* @ param int $amount Amount to reduce by . Default : 1
2014-04-25 14:27:58 +00:00
* @ return int new stock level
2011-08-09 15:16:18 +00:00
*/
2014-04-25 14:27:58 +00:00
public function reduce_stock ( $amount = 1 ) {
return $this -> set_stock ( $amount , 'subtract' );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +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
*
2014-08-31 05:49:58 +00:00
* @ param int $amount Amount to increase by . Default 1.
2014-04-25 14:27:58 +00:00
* @ return int new stock level
2011-08-09 15:16:18 +00:00
*/
2014-04-25 14:27:58 +00:00
public function increase_stock ( $amount = 1 ) {
2014-06-24 17:56:33 +00:00
return $this -> set_stock ( $amount , 'add' );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +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 .
2011-11-17 10:40:32 +00:00
*
2014-09-07 23:37:55 +00:00
* @ param string $type Array or string of types
2012-08-15 17:08:42 +00:00
* @ return bool
2011-08-09 15:16:18 +00:00
*/
2013-07-23 10:28:59 +00:00
public function is_type ( $type ) {
2016-10-17 11:22:23 +00:00
return ( $this -> get_type () === $type || ( is_array ( $type ) && in_array ( $this -> get_type (), $type ) ) );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2011-11-05 19:03:03 +00:00
/**
2015-11-03 12:28:01 +00:00
* Checks if a product is downloadable .
2012-08-15 17:08:42 +00:00
*
* @ return bool
2011-11-05 19:03:03 +00:00
*/
2013-07-23 10:28:59 +00:00
public function is_downloadable () {
2016-09-07 22:32:24 +00:00
return ( 'yes' === $this -> downloadable );
2011-11-05 19:03:03 +00:00
}
2012-08-06 23:33:52 +00:00
2012-07-31 11:58:00 +00:00
/**
2012-08-04 08:28:39 +00:00
* Check if downloadable product has a file attached .
*
* @ since 1.6 . 2
*
2012-08-28 15:21:54 +00:00
* @ param string $download_id file identifier
2012-08-04 08:28:39 +00:00
* @ return bool Whether downloadable product has a file attached .
2012-07-31 11:58:00 +00:00
*/
2013-07-23 10:28:59 +00:00
public function has_file ( $download_id = '' ) {
2013-09-20 16:01:09 +00:00
return ( $this -> is_downloadable () && $this -> get_file ( $download_id ) ) ? true : false ;
}
/**
* Gets an array of downloadable files for this product .
*
* @ since 2.1 . 0
*
* @ return array
*/
public function get_files () {
2014-08-31 05:49:58 +00:00
2013-09-20 16:01:09 +00:00
$downloadable_files = array_filter ( isset ( $this -> downloadable_files ) ? ( array ) maybe_unserialize ( $this -> downloadable_files ) : array () );
2015-03-27 15:15:40 +00:00
if ( ! empty ( $downloadable_files ) ) {
2014-08-31 05:49:58 +00:00
2013-09-20 16:01:09 +00:00
foreach ( $downloadable_files as $key => $file ) {
2014-08-31 05:49:58 +00:00
2013-09-20 16:01:09 +00:00
if ( ! is_array ( $file ) ) {
$downloadable_files [ $key ] = array (
'file' => $file ,
2016-08-27 01:46:45 +00:00
'name' => '' ,
2013-09-20 16:01:09 +00:00
);
}
// Set default name
2013-11-24 10:42:36 +00:00
if ( empty ( $file [ 'name' ] ) ) {
2014-01-20 01:21:50 +00:00
$downloadable_files [ $key ][ 'name' ] = wc_get_filename_from_url ( $file [ 'file' ] );
2013-11-24 10:42:36 +00:00
}
2013-09-20 16:01:09 +00:00
// Filter URL
2013-12-16 23:27:57 +00:00
$downloadable_files [ $key ][ 'file' ] = apply_filters ( 'woocommerce_file_download_path' , $downloadable_files [ $key ][ 'file' ], $this , $key );
2013-09-20 16:01:09 +00:00
}
}
2013-12-16 23:27:57 +00:00
return apply_filters ( 'woocommerce_product_files' , $downloadable_files , $this );
2013-09-20 16:01:09 +00:00
}
/**
2015-11-03 12:28:01 +00:00
* Get a file by $download_id .
2013-09-20 16:01:09 +00:00
*
* @ param string $download_id file identifier
* @ return array | false if not found
*/
2014-04-24 15:00:35 +00:00
public function get_file ( $download_id = '' ) {
2014-08-31 05:49:58 +00:00
2013-09-20 16:01:09 +00:00
$files = $this -> get_files ();
2014-04-24 15:00:35 +00:00
if ( '' === $download_id ) {
$file = sizeof ( $files ) ? current ( $files ) : false ;
} elseif ( isset ( $files [ $download_id ] ) ) {
2013-09-20 16:01:09 +00:00
$file = $files [ $download_id ];
2013-11-24 10:42:36 +00:00
} else {
2013-09-20 16:01:09 +00:00
$file = false ;
2013-11-24 10:42:36 +00:00
}
2013-09-20 16:01:09 +00:00
// allow overriding based on the particular file being requested
2013-12-16 23:27:57 +00:00
return apply_filters ( 'woocommerce_product_file' , $file , $this , $download_id );
2012-07-31 11:58:00 +00:00
}
2012-11-27 16:22:47 +00:00
2012-08-28 15:21:54 +00:00
/**
2015-11-03 12:28:01 +00:00
* Get file download path identified by $download_id .
2012-11-27 16:22:47 +00:00
*
2012-08-28 15:21:54 +00:00
* @ param string $download_id file identifier
2013-09-20 16:01:09 +00:00
* @ return string
2012-08-28 15:21:54 +00:00
*/
2013-07-23 10:28:59 +00:00
public function get_file_download_path ( $download_id ) {
2013-09-20 16:01:09 +00:00
$files = $this -> get_files ();
2012-11-27 16:22:47 +00:00
2013-11-24 10:42:36 +00:00
if ( isset ( $files [ $download_id ] ) ) {
2013-09-20 16:01:09 +00:00
$file_path = $files [ $download_id ][ 'file' ];
2013-11-24 10:42:36 +00:00
} else {
2012-11-21 18:07:45 +00:00
$file_path = '' ;
2013-11-24 10:42:36 +00:00
}
2012-08-28 15:21:54 +00:00
// allow overriding based on the particular file being requested
2013-12-16 23:27:57 +00:00
return apply_filters ( 'woocommerce_product_file_download_path' , $file_path , $this , $download_id );
2012-08-28 15:21:54 +00:00
}
2012-08-06 23:33:52 +00:00
2011-11-05 19:03:03 +00:00
/**
2012-08-15 17:08:42 +00:00
* Checks if a product is virtual ( has no shipping ) .
*
* @ return bool
2011-11-05 19:03:03 +00:00
*/
2013-07-23 10:28:59 +00:00
public function is_virtual () {
2016-09-07 22:32:24 +00:00
return apply_filters ( 'woocommerce_is_virtual' , ( 'yes' === $this -> virtual ), $this );
2011-11-05 19:03:03 +00:00
}
2012-08-06 23:33:52 +00:00
2011-11-05 19:03:03 +00:00
/**
2012-08-15 17:08:42 +00:00
* Checks if a product needs shipping .
*
* @ return bool
2011-11-05 19:03:03 +00:00
*/
2013-07-23 10:28:59 +00:00
public function needs_shipping () {
2013-08-14 09:53:08 +00:00
return apply_filters ( 'woocommerce_product_needs_shipping' , $this -> is_virtual () ? false : true , $this );
2012-04-20 11:09:49 +00:00
}
2012-11-27 16:22:47 +00:00
2012-04-20 11:09:49 +00:00
/**
2015-11-03 12:28:01 +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
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function is_sold_individually () {
2014-08-31 05:49:58 +00:00
2012-04-20 11:09:49 +00:00
$return = false ;
2012-08-06 23:33:52 +00:00
2015-01-07 10:03:49 +00:00
if ( 'yes' == $this -> sold_individually ) {
2012-04-20 11:09:49 +00:00
$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 );
2011-11-05 19:03:03 +00:00
}
2012-08-06 23:33:52 +00:00
2015-02-03 15:06:08 +00:00
/**
2016-01-04 11:43:56 +00:00
* Returns the child product .
2015-02-03 15:06:08 +00:00
*
* @ param mixed $child_id
2016-01-04 11:43:56 +00:00
* @ return WC_Product | WC_Product | WC_Product_variation
2015-02-03 15:06:08 +00:00
*/
public function get_child ( $child_id ) {
return wc_get_product ( $child_id );
}
2012-11-21 18:07:45 +00:00
/**
2016-01-04 11:43:56 +00:00
* Returns the children .
2012-11-27 16:22:47 +00:00
*
2014-02-07 17:31:00 +00:00
* @ return array
2012-11-21 18:07:45 +00:00
*/
2013-07-23 10:28:59 +00:00
public function get_children () {
2012-11-21 18:07:45 +00:00
return array ();
}
2012-11-27 16:22:47 +00:00
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product has any child product .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function has_child () {
2012-11-21 18:07:45 +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 post exists .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function exists () {
2012-11-29 16:48:40 +00:00
return empty ( $this -> post ) ? false : true ;
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 taxable .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function is_taxable () {
2015-07-15 18:12:12 +00:00
$taxable = $this -> get_tax_status () === 'taxable' && wc_tax_enabled () ? true : false ;
2014-02-22 20:15:41 +00:00
return apply_filters ( 'woocommerce_product_is_taxable' , $taxable , $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 shipping is taxable .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function is_shipping_taxable () {
2015-07-15 18:12:12 +00:00
return $this -> get_tax_status () === 'taxable' || $this -> get_tax_status () === 'shipping' ? 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
/**
2013-09-25 11:35:06 +00:00
* Get the add to url used mainly in loops .
2012-08-15 17:08:42 +00:00
*
* @ return string
*/
2013-07-23 10:28:59 +00:00
public function add_to_cart_url () {
2016-09-23 07:19:35 +00:00
return apply_filters ( 'woocommerce_product_add_to_cart_url' , get_permalink ( $this -> get_id () ), $this );
2013-09-25 11:35:06 +00:00
}
/**
2015-11-03 12:28:01 +00:00
* Get the add to cart button text for the single page .
2013-09-25 11:35:06 +00:00
*
* @ return string
*/
public function single_add_to_cart_text () {
return apply_filters ( 'woocommerce_product_single_add_to_cart_text' , __ ( 'Add to cart' , 'woocommerce' ), $this );
}
/**
2015-11-03 12:28:01 +00:00
* Get the add to cart button text .
2013-09-25 11:35:06 +00:00
*
* @ return string
*/
public function add_to_cart_text () {
return apply_filters ( 'woocommerce_product_add_to_cart_text' , __ ( 'Read more' , 'woocommerce' ), $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 stock managed .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function managing_stock () {
2016-09-23 07:19:35 +00:00
$managing_stock = 'no' === $this -> get_manage_stock () || 'yes' !== get_option ( 'woocommerce_manage_stock' );
return ! $managing_stock ;
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 in stock .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function is_in_stock () {
2016-09-07 22:32:24 +00:00
return apply_filters ( 'woocommerce_product_is_in_stock' , ( 'instock' === $this -> stock_status ), $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 can be backordered .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function backorders_allowed () {
2016-09-23 07:19:35 +00:00
return apply_filters ( 'woocommerce_product_backorders_allowed' , ( 'yes' === $this -> get_backorders () || 'notify' === $this -> get_backorders () ), $this -> get_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
/**
* Returns whether or not the product needs to notify the customer on backorder .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function backorders_require_notification () {
2016-09-07 22:32:24 +00:00
return apply_filters ( 'woocommerce_product_backorders_require_notification' , ( $this -> managing_stock () && 'notify' === $this -> backorders ), $this );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-07-17 18:11:14 +00:00
/**
2015-11-03 12:28:01 +00:00
* Check if a product is on backorder .
2012-08-15 17:08:42 +00:00
*
* @ param int $qty_in_cart ( default : 0 )
* @ return bool
2012-07-17 18:11:14 +00:00
*/
2013-07-23 10:28:59 +00:00
public function is_on_backorder ( $qty_in_cart = 0 ) {
2012-11-21 18:07:45 +00:00
return $this -> managing_stock () && $this -> backorders_allowed () && ( $this -> get_total_stock () - $qty_in_cart ) < 0 ? true : false ;
2012-07-17 18:11:14 +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 enough stock for the order .
*
* @ param mixed $quantity
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function has_enough_stock ( $quantity ) {
2015-03-20 10:40:00 +00:00
return ! $this -> managing_stock () || $this -> backorders_allowed () || $this -> get_stock_quantity () >= $quantity ? 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 the availability of the product .
*
2016-06-23 10:24:15 +00:00
* If stock management is enabled at global and product level , a stock message
* will be shown . e . g . In stock , In stock x10 , Out of stock .
*
* If stock management is disabled at global or product level , out of stock
* will be shown when needed , but in stock will be hidden from view .
*
* This can all be changed through use of the woocommerce_get_availability filter .
*
2012-08-15 17:08:42 +00:00
* @ return string
*/
2013-07-23 10:28:59 +00:00
public function get_availability () {
2016-06-23 10:24:15 +00:00
return apply_filters ( 'woocommerce_get_availability' , array (
'availability' => $this -> get_availability_text (),
'class' => $this -> get_availability_class (),
), $this );
}
2014-08-31 05:49:58 +00:00
2016-06-23 10:24:15 +00:00
/**
* Get availability text based on stock status .
*
* @ return string
*/
protected function get_availability_text () {
2016-05-03 14:10:28 +00:00
if ( ! $this -> is_in_stock () ) {
$availability = __ ( 'Out of stock' , 'woocommerce' );
} elseif ( $this -> managing_stock () && $this -> is_on_backorder ( 1 ) ) {
2016-06-29 14:51:20 +00:00
$availability = $this -> backorders_require_notification () ? __ ( 'Available on backorder' , 'woocommerce' ) : __ ( 'In stock' , 'woocommerce' );
2016-05-03 14:10:28 +00:00
} elseif ( $this -> managing_stock () ) {
switch ( get_option ( 'woocommerce_stock_format' ) ) {
case 'no_amount' :
$availability = __ ( 'In stock' , 'woocommerce' );
break ;
case 'low_amount' :
if ( $this -> get_total_stock () <= get_option ( 'woocommerce_notify_low_stock_amount' ) ) {
2016-10-29 10:16:03 +00:00
/* translators: %s: total items in stock */
2016-05-03 14:10:28 +00:00
$availability = sprintf ( __ ( 'Only %s left in stock' , 'woocommerce' ), $this -> get_total_stock () );
2014-08-13 14:03:30 +00:00
if ( $this -> backorders_allowed () && $this -> backorders_require_notification () ) {
2016-05-03 14:10:28 +00:00
$availability .= ' ' . __ ( '(also available on backorder)' , 'woocommerce' );
2014-08-13 14:03:30 +00:00
}
2016-05-03 14:10:28 +00:00
} else {
$availability = __ ( 'In stock' , 'woocommerce' );
}
break ;
default :
2016-10-29 10:16:03 +00:00
/* translators: %s: total items in stock */
2016-05-03 14:10:28 +00:00
$availability = sprintf ( __ ( '%s in stock' , 'woocommerce' ), $this -> get_total_stock () );
2014-08-31 05:49:58 +00:00
2016-05-03 14:10:28 +00:00
if ( $this -> backorders_allowed () && $this -> backorders_require_notification () ) {
$availability .= ' ' . __ ( '(also available on backorder)' , 'woocommerce' );
}
break ;
2012-11-29 16:48:40 +00:00
}
2016-06-23 10:24:15 +00:00
} else {
$availability = '' ;
2012-11-29 16:48:40 +00:00
}
2016-06-23 10:24:15 +00:00
return apply_filters ( 'woocommerce_get_availability_text' , $availability , $this );
}
2014-08-31 05:49:58 +00:00
2016-06-23 10:24:15 +00:00
/**
* Get availability classname based on stock status .
*
* @ return string
*/
protected function get_availability_class () {
if ( ! $this -> is_in_stock () ) {
$class = 'out-of-stock' ;
2016-06-29 14:51:20 +00:00
} elseif ( $this -> managing_stock () && $this -> is_on_backorder ( 1 ) && $this -> backorders_require_notification () ) {
2016-06-23 10:24:15 +00:00
$class = 'available-on-backorder' ;
} else {
$class = 'in-stock' ;
}
2016-09-23 07:19:35 +00:00
2016-06-23 10:24:15 +00:00
return apply_filters ( 'woocommerce_get_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 .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function is_featured () {
2016-09-23 07:19:35 +00:00
return 'yes' === $this -> get_featured ();
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
2014-08-04 10:19:58 +00:00
* Returns whether or not the product is visible in the catalog .
2012-08-15 17:08:42 +00:00
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function is_visible () {
2014-10-21 13:50:15 +00:00
if ( ! $this -> post ) {
$visible = false ;
2016-09-23 07:19:35 +00:00
// Published/private.
} elseif ( 'publish' !== $this -> post -> post_status && ! current_user_can ( 'edit_post' , $this -> get_id () ) ) {
2014-08-04 10:19:58 +00:00
$visible = false ;
2016-09-23 07:19:35 +00:00
// Out of stock visibility.
2014-08-04 10:19:58 +00:00
} elseif ( 'yes' === get_option ( 'woocommerce_hide_out_of_stock_items' ) && ! $this -> is_in_stock () ) {
2013-11-24 10:42:36 +00:00
$visible = false ;
2012-08-06 23:33:52 +00:00
2016-09-23 07:19:35 +00:00
// visibility setting.
2014-08-04 10:19:58 +00:00
} elseif ( 'hidden' === $this -> visibility ) {
2013-11-24 10:42:36 +00:00
$visible = false ;
2014-08-04 10:19:58 +00:00
} elseif ( 'visible' === $this -> visibility ) {
2013-11-24 10:42:36 +00:00
$visible = true ;
2012-08-06 23:33:52 +00:00
2016-09-23 07:19:35 +00:00
// Visibility in loop.
2014-08-04 10:19:58 +00:00
} elseif ( is_search () ) {
$visible = 'search' === $this -> visibility ;
} else {
$visible = 'catalog' === $this -> visibility ;
2013-11-24 10:42:36 +00:00
}
2012-08-06 23:33:52 +00:00
2016-09-23 07:19:35 +00:00
return apply_filters ( 'woocommerce_product_is_visible' , $visible , $this -> get_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 .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function is_on_sale () {
2015-02-10 12:34:53 +00:00
return apply_filters ( 'woocommerce_product_is_on_sale' , ( $this -> get_sale_price () !== $this -> get_regular_price () && $this -> get_sale_price () === $this -> get_price () ), $this );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2013-07-23 10:28:59 +00:00
/**
* Returns false if the product cannot be bought .
*
2014-03-21 21:37:26 +00:00
* @ return bool
2013-07-23 10:28:59 +00:00
*/
public function is_purchasable () {
$purchasable = true ;
2016-09-23 07:19:35 +00:00
// Products must exist of course.
2013-11-24 10:42:36 +00:00
if ( ! $this -> exists () ) {
2013-07-23 10:28:59 +00:00
$purchasable = false ;
2016-09-23 07:19:35 +00:00
// Other products types need a price to be set.
2013-11-24 10:42:36 +00:00
} elseif ( $this -> get_price () === '' ) {
2013-07-23 10:28:59 +00:00
$purchasable = false ;
2016-09-23 07:19:35 +00:00
// Check the product is published.
} elseif ( 'publish' !== $this -> post -> post_status && ! current_user_can ( 'edit_post' , $this -> get_id () ) ) {
2013-07-23 10:28:59 +00:00
$purchasable = false ;
2013-11-24 10:42:36 +00:00
}
2013-07-23 10:28:59 +00:00
return apply_filters ( 'woocommerce_is_purchasable' , $purchasable , $this );
}
2012-08-15 17:08:42 +00:00
/**
* Set a products price dynamically .
*
* @ param float $price Price to set .
*/
2013-07-23 10:28:59 +00:00
public function set_price ( $price ) {
2012-07-16 16:23:17 +00:00
$this -> price = $price ;
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
* Adjust a products price dynamically .
*
2012-11-29 16:48:40 +00:00
* @ param mixed $price
2012-08-15 17:08:42 +00:00
*/
2013-07-23 10:28:59 +00:00
public function adjust_price ( $price ) {
2013-03-13 15:08:58 +00:00
$this -> price = $this -> price + $price ;
2011-11-06 13:45:18 +00:00
}
2012-08-06 23:33:52 +00:00
2013-07-23 10:28:59 +00:00
/**
* Returns the product ' s active price .
*
* @ return string price
*/
public function get_price () {
return apply_filters ( 'woocommerce_get_price' , $this -> price , $this );
}
2012-08-15 17:08:42 +00:00
2012-12-03 16:36:54 +00:00
/**
* Returns the price ( including tax ) . Uses customer tax rates . Can work for a specific $qty for more accurate taxes .
*
2016-01-04 11:43:56 +00:00
* @ param int $qty
2014-11-21 21:26:32 +00:00
* @ param string $price to calculate , left blank to just use get_price ()
2012-12-03 16:36:54 +00:00
* @ return string
*/
2013-09-19 15:31:54 +00:00
public function get_price_including_tax ( $qty = 1 , $price = '' ) {
2014-08-31 05:49:58 +00:00
2016-09-07 22:32:24 +00:00
if ( '' === $price ) {
2013-09-19 15:31:54 +00:00
$price = $this -> get_price ();
2013-11-24 10:42:36 +00:00
}
2012-12-03 16:36:54 +00:00
if ( $this -> is_taxable () ) {
2014-12-03 09:28:04 +00:00
if ( get_option ( 'woocommerce_prices_include_tax' ) === 'no' ) {
2012-12-03 16:36:54 +00:00
2014-06-12 15:47:43 +00:00
$tax_rates = WC_Tax :: get_rates ( $this -> get_tax_class () );
$taxes = WC_Tax :: calc_tax ( $price * $qty , $tax_rates , false );
$tax_amount = WC_Tax :: get_tax_total ( $taxes );
2015-01-23 11:50:32 +00:00
$price = round ( $price * $qty + $tax_amount , wc_get_price_decimals () );
2012-12-03 16:36:54 +00:00
} else {
2014-06-12 15:47:43 +00:00
$tax_rates = WC_Tax :: get_rates ( $this -> get_tax_class () );
2014-11-11 11:56:13 +00:00
$base_tax_rates = WC_Tax :: get_base_tax_rates ( $this -> tax_class );
2012-12-03 16:36:54 +00:00
2016-03-09 20:49:02 +00:00
if ( ! empty ( WC () -> customer ) && WC () -> customer -> get_is_vat_exempt () ) {
2012-12-03 16:36:54 +00:00
2014-08-31 05:49:58 +00:00
$base_taxes = WC_Tax :: calc_tax ( $price * $qty , $base_tax_rates , true );
$base_tax_amount = array_sum ( $base_taxes );
2015-01-23 11:50:32 +00:00
$price = round ( $price * $qty - $base_tax_amount , wc_get_price_decimals () );
2012-12-03 16:36:54 +00:00
2015-09-15 15:01:11 +00:00
/**
* The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing with out of base locations .
* e . g . If a product costs 10 including tax , all users will pay 10 regardless of location and taxes .
* This feature is experimental @ since 2.4 . 7 and may change in the future . Use at your risk .
*/
2015-09-04 09:48:50 +00:00
} elseif ( $tax_rates !== $base_tax_rates && apply_filters ( 'woocommerce_adjust_non_base_location_prices' , true ) ) {
2012-12-03 16:36:54 +00:00
2014-08-31 05:49:58 +00:00
$base_taxes = WC_Tax :: calc_tax ( $price * $qty , $base_tax_rates , true );
$modded_taxes = WC_Tax :: calc_tax ( ( $price * $qty ) - array_sum ( $base_taxes ), $tax_rates , false );
2015-01-23 11:50:32 +00:00
$price = round ( ( $price * $qty ) - array_sum ( $base_taxes ) + array_sum ( $modded_taxes ), wc_get_price_decimals () );
2012-12-03 16:36:54 +00:00
} else {
$price = $price * $qty ;
}
}
} else {
$price = $price * $qty ;
}
return apply_filters ( 'woocommerce_get_price_including_tax' , $price , $qty , $this );
}
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 .
2012-12-03 16:36:54 +00:00
* Uses store base tax rates . Can work for a specific $qty for more accurate taxes .
2012-08-15 17:08:42 +00:00
*
2016-01-04 11:43:56 +00:00
* @ param int $qty
2014-11-21 21:26:32 +00:00
* @ param string $price to calculate , left blank to just use get_price ()
2012-08-15 17:08:42 +00:00
* @ return string
*/
2013-09-19 15:31:54 +00:00
public function get_price_excluding_tax ( $qty = 1 , $price = '' ) {
2012-08-06 23:33:52 +00:00
2016-09-07 22:32:24 +00:00
if ( '' === $price ) {
2013-09-19 15:31:54 +00:00
$price = $this -> get_price ();
2013-11-24 10:42:36 +00:00
}
2011-08-09 15:16:18 +00:00
2015-09-04 09:57:22 +00:00
if ( $this -> is_taxable () && 'yes' === get_option ( 'woocommerce_prices_include_tax' ) ) {
2014-11-11 11:56:13 +00:00
$tax_rates = WC_Tax :: get_base_tax_rates ( $this -> tax_class );
2014-06-12 15:47:43 +00:00
$taxes = WC_Tax :: calc_tax ( $price * $qty , $tax_rates , true );
$price = WC_Tax :: round ( $price * $qty - array_sum ( $taxes ) );
2012-12-03 16:36:54 +00:00
} else {
$price = $price * $qty ;
2012-11-29 16:48:40 +00:00
}
2012-08-06 23:33:52 +00:00
2012-12-03 16:36:54 +00:00
return apply_filters ( 'woocommerce_get_price_excluding_tax' , $price , $qty , $this );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2014-12-03 09:28:04 +00:00
/**
* Returns the price including or excluding tax , based on the 'woocommerce_tax_display_shop' setting .
*
* @ param string $price to calculate , left blank to just use get_price ()
* @ param integer $qty passed on to get_price_including_tax () or get_price_excluding_tax ()
* @ return string
*/
public function get_display_price ( $price = '' , $qty = 1 ) {
2016-09-07 22:32:24 +00:00
if ( '' === $price ) {
2014-12-03 09:28:04 +00:00
$price = $this -> get_price ();
}
$tax_display_mode = get_option ( 'woocommerce_tax_display_shop' );
2016-09-07 22:32:24 +00:00
$display_price = ( 'incl' === $tax_display_mode ) ? $this -> get_price_including_tax ( $qty , $price ) : $this -> get_price_excluding_tax ( $qty , $price );
2014-12-03 09:28:04 +00:00
2016-10-12 10:54:21 +00:00
return apply_filters ( 'woocommerce_get_display_price' , $display_price , $price , $qty );
2014-12-03 09:28:04 +00:00
}
2013-09-19 15:31:54 +00:00
/**
2015-11-03 12:28:01 +00:00
* Get the suffix to display after prices > 0.
2014-08-31 05:49:58 +00:00
*
2015-06-29 19:24:48 +00:00
* @ param string $price to calculate , left blank to just use get_price ()
* @ param integer $qty passed on to get_price_including_tax () or get_price_excluding_tax ()
2013-09-19 15:31:54 +00:00
* @ return string
*/
2015-06-29 19:24:48 +00:00
public function get_price_suffix ( $price = '' , $qty = 1 ) {
2016-09-07 22:32:24 +00:00
if ( '' === $price ) {
2015-06-29 19:24:48 +00:00
$price = $this -> get_price ();
}
2014-08-31 05:49:58 +00:00
2013-09-19 15:31:54 +00:00
$price_display_suffix = get_option ( 'woocommerce_price_display_suffix' );
2016-09-07 11:34:37 +00:00
$woocommerce_calc_taxes = get_option ( 'woocommerce_calc_taxes' , 'no' );
2013-09-19 15:31:54 +00:00
2016-09-07 11:12:18 +00:00
if ( $price_display_suffix && 'yes' === $woocommerce_calc_taxes ) {
2014-08-31 05:49:58 +00:00
2013-09-19 15:31:54 +00:00
$price_display_suffix = ' <small class="woocommerce-price-suffix">' . $price_display_suffix . '</small>' ;
$find = array (
'{price_including_tax}' ,
2016-08-27 02:08:49 +00:00
'{price_excluding_tax}' ,
2013-09-19 15:31:54 +00:00
);
$replace = array (
2015-06-29 19:24:48 +00:00
wc_price ( $this -> get_price_including_tax ( $qty , $price ) ),
2016-08-27 02:08:49 +00:00
wc_price ( $this -> get_price_excluding_tax ( $qty , $price ) ),
2013-09-19 15:31:54 +00:00
);
$price_display_suffix = str_replace ( $find , $replace , $price_display_suffix );
2016-09-07 11:01:55 +00:00
} else {
2016-09-07 10:38:38 +00:00
$price_display_suffix = '' ;
}
2013-09-19 15:31:54 +00:00
return apply_filters ( 'woocommerce_get_price_suffix' , $price_display_suffix , $this );
}
2012-08-15 17:08:42 +00:00
/**
* Returns the price in html format .
*
* @ param string $price ( default : '' )
* @ return string
*/
2013-07-23 10:28:59 +00:00
public function get_price_html ( $price = '' ) {
2012-08-06 23:33:52 +00:00
2014-12-03 09:28:04 +00:00
$display_price = $this -> get_display_price ();
$display_regular_price = $this -> get_display_price ( $this -> get_regular_price () );
2013-07-23 10:28:59 +00:00
2013-09-19 15:31:54 +00:00
if ( $this -> get_price () > 0 ) {
2012-08-06 23:33:52 +00:00
2013-07-23 10:28:59 +00:00
if ( $this -> is_on_sale () && $this -> get_regular_price () ) {
2013-09-19 15:31:54 +00:00
$price .= $this -> get_price_html_from_to ( $display_regular_price , $display_price ) . $this -> get_price_suffix ();
2012-08-06 23:33:52 +00:00
2012-11-21 18:07:45 +00:00
$price = apply_filters ( 'woocommerce_sale_price_html' , $price , $this );
2012-08-06 23:33:52 +00:00
2012-02-27 13:47:18 +00:00
} else {
2012-08-06 23:33:52 +00:00
2013-11-25 13:34:21 +00:00
$price .= wc_price ( $display_price ) . $this -> get_price_suffix ();
2012-02-27 13:23:03 +00:00
2012-11-21 18:07:45 +00:00
$price = apply_filters ( 'woocommerce_price_html' , $price , $this );
2012-08-06 23:33:52 +00:00
2012-10-08 11:51:00 +00:00
}
2013-09-19 15:31:54 +00:00
} elseif ( $this -> get_price () === '' ) {
$price = apply_filters ( 'woocommerce_empty_price_html' , '' , $this );
2013-07-23 10:28:59 +00:00
} elseif ( $this -> get_price () == 0 ) {
2012-02-25 08:03:00 +00:00
2013-07-23 10:28:59 +00:00
if ( $this -> is_on_sale () && $this -> get_regular_price () ) {
2012-08-06 23:33:52 +00:00
2013-09-19 15:31:54 +00:00
$price .= $this -> get_price_html_from_to ( $display_regular_price , __ ( 'Free!' , 'woocommerce' ) );
2012-02-25 08:03:00 +00:00
2012-11-21 18:07:45 +00:00
$price = apply_filters ( 'woocommerce_free_sale_price_html' , $price , $this );
2012-02-25 08:03:00 +00:00
2012-11-21 18:07:45 +00:00
} else {
2012-02-25 08:03:00 +00:00
2015-09-04 10:19:52 +00:00
$price = '<span class="amount">' . __ ( 'Free!' , 'woocommerce' ) . '</span>' ;
2012-02-25 08:03:00 +00:00
2012-11-21 18:07:45 +00:00
$price = apply_filters ( 'woocommerce_free_price_html' , $price , $this );
2012-08-06 23:33:52 +00:00
2012-10-18 10:33:47 +00:00
}
}
2012-08-06 23:33:52 +00:00
2012-10-18 10:33:47 +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 .
2014-01-07 07:13:31 +00:00
*
2012-08-15 17:08:42 +00:00
* @ return string
*/
2013-12-05 01:46:12 +00:00
public function get_price_html_from_text () {
2016-10-25 17:04:59 +00:00
$from = '<span class="from">' . _x ( 'From:' , 'From minimum price' , 'woocommerce' ) . ' </span>' ;
2014-10-17 15:25:54 +00:00
2014-10-02 19:11:34 +00:00
return apply_filters ( 'woocommerce_get_price_html_from_text' , $from , $this );
2012-02-26 14:11:56 +00:00
}
2012-08-15 17:08:42 +00:00
/**
* Functions for getting parts of a price , in html , used by get_price_html .
*
2014-09-07 23:37:55 +00:00
* @ param string $from String or float to wrap with 'from' text
2013-12-04 12:45:23 +00:00
* @ param mixed $to String or float to wrap with 'to' text
2012-08-15 17:08:42 +00:00
* @ return string
*/
2013-07-23 10:28:59 +00:00
public function get_price_html_from_to ( $from , $to ) {
2014-10-02 19:11:34 +00:00
$price = '<del>' . ( ( is_numeric ( $from ) ) ? wc_price ( $from ) : $from ) . '</del> <ins>' . ( ( is_numeric ( $to ) ) ? wc_price ( $to ) : $to ) . '</ins>' ;
2014-10-17 15:25:54 +00:00
return apply_filters ( 'woocommerce_get_price_html_from_to' , $price , $from , $to , $this );
2012-02-26 14:11:56 +00:00
}
2012-08-06 23:33:52 +00:00
2012-08-15 17:08:42 +00:00
/**
2015-11-13 20:41:20 +00:00
* Get the average rating of product . This is calculated once and stored in postmeta .
2013-11-27 18:20:31 +00:00
* @ return string
2012-08-15 17:08:42 +00:00
*/
2013-07-23 10:28:59 +00:00
public function get_average_rating () {
2016-02-09 20:53:18 +00:00
// No meta data? Do the calculation
2016-09-23 07:19:35 +00:00
if ( ! metadata_exists ( 'post' , $this -> get_id (), '_wc_average_rating' ) ) {
$this -> sync_average_rating ( $this -> get_id () );
2013-01-12 10:53:24 +00:00
}
2016-09-23 07:19:35 +00:00
return ( string ) floatval ( get_post_meta ( $this -> get_id (), '_wc_average_rating' , true ) );
2013-01-12 10:53:24 +00:00
}
/**
2014-11-21 21:34:30 +00:00
* Get the total amount ( COUNT ) of ratings .
2015-11-13 20:41:20 +00:00
* @ param int $value Optional . Rating value to get the count for . By default returns the count of all rating values .
2013-11-27 18:20:31 +00:00
* @ return int
2013-01-12 10:53:24 +00:00
*/
2014-09-17 08:27:43 +00:00
public function get_rating_count ( $value = null ) {
2016-02-09 20:53:18 +00:00
// No meta data? Do the calculation
2016-09-23 07:19:35 +00:00
if ( ! metadata_exists ( 'post' , $this -> get_id (), '_wc_rating_count' ) ) {
$this -> sync_rating_count ( $this -> get_id () );
2016-02-09 20:53:18 +00:00
}
2016-09-23 07:19:35 +00:00
$counts = get_post_meta ( $this -> get_id (), '_wc_rating_count' , true );
2016-02-09 20:53:18 +00:00
if ( is_null ( $value ) ) {
return array_sum ( $counts );
} else {
return isset ( $counts [ $value ] ) ? $counts [ $value ] : 0 ;
}
}
/**
* Sync product rating . Can be called statically .
* @ param int $post_id
*/
public static function sync_average_rating ( $post_id ) {
if ( ! metadata_exists ( 'post' , $post_id , '_wc_rating_count' ) ) {
self :: sync_rating_count ( $post_id );
}
$count = array_sum ( ( array ) get_post_meta ( $post_id , '_wc_rating_count' , true ) );
if ( $count ) {
global $wpdb ;
$ratings = $wpdb -> get_var ( $wpdb -> prepare ( "
SELECT SUM ( meta_value ) FROM $wpdb -> commentmeta
2015-02-11 22:55:16 +00:00
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'
2015-05-25 01:00:20 +00:00
AND meta_value > 0
2016-02-09 20:53:18 +00:00
" , $post_id ) );
$average = number_format ( $ratings / $count , 2 , '.' , '' );
2015-11-13 20:41:20 +00:00
} else {
2016-02-09 20:53:18 +00:00
$average = 0 ;
2013-01-12 10:53:24 +00:00
}
2016-02-09 20:53:18 +00:00
update_post_meta ( $post_id , '_wc_average_rating' , $average );
}
2012-08-06 23:33:52 +00:00
2016-02-09 20:53:18 +00:00
/**
* Sync product rating count . Can be called statically .
* @ param int $post_id
*/
public static function sync_rating_count ( $post_id ) {
global $wpdb ;
$counts = array ();
2016-06-28 14:24:35 +00:00
$raw_counts = $wpdb -> get_results ( $wpdb -> prepare ( "
2016-02-09 20:53:18 +00:00
SELECT meta_value , COUNT ( * ) as meta_value_count 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
GROUP BY meta_value
" , $post_id ) );
foreach ( $raw_counts as $count ) {
$counts [ $count -> meta_value ] = $count -> meta_value_count ;
2015-05-25 01:00:20 +00:00
}
2016-02-09 20:53:18 +00:00
update_post_meta ( $post_id , '_wc_rating_count' , $counts );
2013-01-12 10:53:24 +00:00
}
2012-08-06 23:33:52 +00:00
2013-01-12 10:53:24 +00:00
/**
2013-03-28 13:58:01 +00:00
* Returns the product rating in html format .
2013-01-12 10:53:24 +00:00
*
2013-03-28 13:58:01 +00:00
* @ param string $rating ( default : '' )
2015-02-10 15:01:04 +00:00
*
2013-03-28 13:58:01 +00:00
* @ return string
2013-01-12 10:53:24 +00:00
*/
2013-07-23 10:28:59 +00:00
public function get_rating_html ( $rating = null ) {
2015-02-10 15:01:04 +00:00
$rating_html = '' ;
2013-01-12 10:53:24 +00:00
2013-11-24 10:42:36 +00:00
if ( ! is_numeric ( $rating ) ) {
2013-03-28 13:58:01 +00:00
$rating = $this -> get_average_rating ();
2013-11-24 10:42:36 +00:00
}
2013-01-12 10:53:24 +00:00
2013-03-28 13:58:01 +00:00
if ( $rating > 0 ) {
2013-01-12 10:53:24 +00:00
2016-11-04 15:40:15 +00:00
$rating_html = '<div class="star-rating">' ;
2013-01-12 10:53:24 +00:00
2016-10-29 10:16:03 +00:00
/* translators: %s: rating */
2016-10-24 07:33:32 +00:00
$rating_html .= '<span style="width:' . ( ( $rating / 5 ) * 100 ) . '%">' . sprintf ( __ ( '%s out of 5' , 'woocommerce' ), '<strong class="rating">' . $rating . '</strong>' ) . '</span>' ;
2013-01-12 10:53:24 +00:00
$rating_html .= '</div>' ;
}
2013-12-02 11:34:27 +00:00
2015-02-10 15:01:04 +00:00
return apply_filters ( 'woocommerce_product_get_rating_html' , $rating_html , $rating );
2011-08-28 12:04:05 +00:00
}
2012-08-06 23:33:52 +00:00
2015-02-11 22:55:16 +00:00
/**
* Get the total amount ( COUNT ) of reviews .
*
* @ since 2.3 . 2
* @ return int The total numver of product reviews
*/
public function get_review_count () {
2015-11-13 20:41:20 +00:00
global $wpdb ;
2015-02-11 22:55:16 +00:00
2015-11-13 20:41:20 +00:00
// No meta date? Do the calculation
2016-09-23 07:19:35 +00:00
if ( ! metadata_exists ( 'post' , $this -> get_id (), '_wc_review_count' ) ) {
2015-02-11 22:55:16 +00:00
$count = $wpdb -> get_var ( $wpdb -> prepare ( "
SELECT COUNT ( * ) FROM $wpdb -> comments
WHERE comment_parent = 0
AND comment_post_ID = % d
AND comment_approved = '1'
2016-09-23 07:19:35 +00:00
" , $this->get_id () ) );
2015-02-11 22:55:16 +00:00
2016-09-23 07:19:35 +00:00
update_post_meta ( $this -> get_id (), '_wc_review_count' , $count );
2015-11-13 20:41:20 +00:00
} else {
2016-09-23 07:19:35 +00:00
$count = get_post_meta ( $this -> get_id (), '_wc_review_count' , true );
2015-02-11 22:55:16 +00:00
}
return apply_filters ( 'woocommerce_product_review_count' , $count , $this );
}
2012-08-15 17:08:42 +00:00
/**
* Returns the upsell product ids .
*
* @ return array
*/
2013-07-23 10:28:59 +00:00
public function get_upsells () {
2015-08-05 12:49:27 +00:00
return apply_filters ( 'woocommerce_product_upsell_ids' , ( array ) maybe_unserialize ( $this -> upsell_ids ), $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
/**
2013-03-03 17:07:31 +00:00
* Returns the cross sell product ids .
2012-08-15 17:08:42 +00:00
*
* @ return array
*/
2013-07-23 10:28:59 +00:00
public function get_cross_sells () {
2015-08-05 12:49:27 +00:00
return apply_filters ( 'woocommerce_product_crosssell_ids' , ( array ) maybe_unserialize ( $this -> crosssell_ids ), $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 product shipping class .
*
* @ return string
*/
2013-07-23 10:28:59 +00:00
public function get_shipping_class () {
2014-08-31 05:49:58 +00:00
2012-11-21 18:07:45 +00:00
if ( ! $this -> shipping_class ) {
2014-08-31 05:49:58 +00:00
2016-09-23 07:19:35 +00:00
$classes = get_the_terms ( $this -> get_id (), 'product_shipping_class' );
2013-11-24 10:42:36 +00:00
if ( $classes && ! is_wp_error ( $classes ) ) {
2012-11-27 16:22:47 +00:00
$this -> shipping_class = current ( $classes ) -> slug ;
2013-11-24 10:42:36 +00:00
} else {
2012-11-21 18:07:45 +00:00
$this -> shipping_class = '' ;
2013-11-24 10:42:36 +00:00
}
2012-11-21 18:07:45 +00:00
}
2014-08-31 05:49:58 +00:00
2011-12-02 20:48:07 +00:00
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 .
*
* @ return int
*/
2013-07-23 10:28:59 +00:00
public function get_shipping_class_id () {
2014-08-31 05:49:58 +00:00
2012-11-29 16:48:40 +00:00
if ( ! $this -> shipping_class_id ) {
2014-08-31 05:49:58 +00:00
2016-09-23 07:19:35 +00:00
$classes = get_the_terms ( $this -> get_id (), 'product_shipping_class' );
2013-11-24 10:42:36 +00:00
if ( $classes && ! is_wp_error ( $classes ) ) {
2012-08-06 23:33:52 +00:00
$this -> shipping_class_id = current ( $classes ) -> term_id ;
2013-11-24 10:42:36 +00:00
} else {
2012-06-03 12:12:08 +00:00
$this -> shipping_class_id = 0 ;
2013-11-24 10:42:36 +00:00
}
2012-11-29 16:48:40 +00:00
}
2014-08-31 05:49:58 +00:00
2012-11-19 14:05:03 +00:00
return absint ( $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 .
*
2015-11-13 21:14:42 +00:00
* Notes :
* - Results are cached in a transient for faster queries .
* - To make results appear random , we query and extra 10 products and shuffle them .
* - To ensure we always have enough results , it will check $limit before returning the cached result , if not recalc .
* - This used to rely on transient version to invalidate cache , but to avoid multiple transients we now just expire daily .
* This means if a related product is edited and no longer related , it won ' t be removed for 24 hours . Acceptable trade - off for performance .
* - Saving a product will flush caches for that product .
*
2016-02-22 13:27:39 +00:00
* @ param int $limit ( default : 5 ) Should be an integer greater than 0.
2012-08-15 17:08:42 +00:00
* @ return array Array of post IDs
*/
2013-07-23 10:28:59 +00:00
public function get_related ( $limit = 5 ) {
2015-11-13 21:14:42 +00:00
global $wpdb ;
2013-11-13 18:00:01 +00:00
2016-09-23 07:19:35 +00:00
$transient_name = 'wc_related_' . $this -> get_id ();
2015-11-13 21:14:42 +00:00
$related_posts = get_transient ( $transient_name );
2016-02-22 13:27:39 +00:00
$limit = $limit > 0 ? $limit : 5 ;
2012-08-06 23:33:52 +00:00
2015-11-13 21:14:42 +00:00
// We want to query related posts if they are not cached, or we don't have enough
if ( false === $related_posts || sizeof ( $related_posts ) < $limit ) {
2015-05-25 14:40:13 +00:00
// Related products are found from category and tag
$tags_array = $this -> get_related_terms ( 'product_tag' );
$cats_array = $this -> get_related_terms ( 'product_cat' );
2013-11-13 18:00:01 +00:00
2015-05-25 14:40:13 +00:00
// Don't bother if none are set
2016-08-27 04:29:49 +00:00
if ( 1 === sizeof ( $cats_array ) && 1 === sizeof ( $tags_array ) ) {
2015-05-25 14:40:13 +00:00
$related_posts = array ();
} else {
// Sanitize
2016-09-23 07:19:35 +00:00
$exclude_ids = array_map ( 'absint' , array_merge ( array ( 0 , $this -> get_id () ), $this -> get_upsells () ) );
2013-11-13 18:00:01 +00:00
2015-11-13 21:14:42 +00:00
// Generate query - but query an extra 10 results to give the appearance of random results
$query = $this -> build_related_query ( $cats_array , $tags_array , $exclude_ids , $limit + 10 );
2012-08-06 23:33:52 +00:00
2015-05-25 14:40:13 +00:00
// Get the posts
$related_posts = $wpdb -> get_col ( implode ( ' ' , $query ) );
}
2015-11-13 21:14:42 +00:00
set_transient ( $transient_name , $related_posts , DAY_IN_SECONDS );
2015-05-25 14:40:13 +00:00
}
2015-11-13 21:14:42 +00:00
// Randomise the results
2015-05-25 14:40:13 +00:00
shuffle ( $related_posts );
2012-08-06 23:33:52 +00:00
2015-11-13 21:14:42 +00:00
// Limit the returned results
return array_slice ( $related_posts , 0 , $limit );
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 .
*
* @ param mixed $attr
2013-03-07 19:34:29 +00:00
* @ return string
2012-08-15 17:08:42 +00:00
*/
2013-07-23 10:28:59 +00:00
public function get_attribute ( $attr ) {
2014-08-31 05:49:58 +00:00
2011-11-26 20:23:57 +00:00
$attributes = $this -> get_attributes ();
2012-08-06 23:33:52 +00:00
2013-04-16 14:39:07 +00:00
$attr = sanitize_title ( $attr );
2012-08-06 23:33:52 +00:00
2012-06-10 17:15:02 +00:00
if ( isset ( $attributes [ $attr ] ) || isset ( $attributes [ 'pa_' . $attr ] ) ) {
2012-08-06 23:33:52 +00:00
2012-06-10 17:15:02 +00:00
$attribute = isset ( $attributes [ $attr ] ) ? $attributes [ $attr ] : $attributes [ 'pa_' . $attr ];
2012-08-06 23:33:52 +00:00
2016-01-20 14:53:51 +00:00
if ( isset ( $attribute [ 'is_taxonomy' ] ) && $attribute [ 'is_taxonomy' ] ) {
2012-08-06 23:33:52 +00:00
2016-09-23 07:19:35 +00:00
return implode ( ', ' , wc_get_product_terms ( $this -> get_id (), $attribute [ 'name' ], array ( 'fields' => 'names' ) ) );
2012-08-06 23:33:52 +00:00
2012-06-10 17:15:02 +00:00
} else {
2012-08-06 23:33:52 +00:00
2012-01-10 17:14:40 +00:00
return $attribute [ 'value' ];
2012-06-10 17:15:02 +00:00
}
}
2013-03-07 19:34:29 +00:00
return '' ;
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 whether or not the product has any attributes set .
*
2014-09-07 23:37:55 +00:00
* @ return boolean
2012-08-15 17:08:42 +00:00
*/
2013-07-23 10:28:59 +00:00
public function has_attributes () {
2014-08-31 05:49:58 +00:00
2012-11-21 18:07:45 +00:00
if ( sizeof ( $this -> get_attributes () ) > 0 ) {
2014-08-31 05:49:58 +00:00
2012-11-21 18:07:45 +00:00
foreach ( $this -> get_attributes () as $attribute ) {
2014-08-31 05:49:58 +00:00
2014-02-07 17:35:45 +00:00
if ( isset ( $attribute [ 'is_visible' ] ) && $attribute [ 'is_visible' ] ) {
2012-11-21 18:07:45 +00:00
return true ;
2014-02-07 17:35:45 +00:00
}
2012-11-21 18:07:45 +00:00
}
}
2014-08-31 05:49:58 +00:00
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 we are showing dimensions on the product page .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function enable_dimensions_display () {
2016-08-03 15:07:34 +00:00
return apply_filters ( 'wc_product_enable_dimensions_display' , true ) && ( $this -> has_dimensions () || $this -> has_weight () );
2012-01-10 15:36:14 +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 dimensions set .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function has_dimensions () {
2012-11-21 18:07:45 +00:00
return $this -> get_dimensions () ? true : false ;
2012-01-10 15:36:14 +00:00
}
2012-08-06 23:33:52 +00:00
2016-08-03 15:07:34 +00:00
/**
* Does a child have dimensions set ?
2016-09-23 07:19:35 +00:00
*
2016-08-03 15:07:34 +00:00
* @ since 2.7 . 0
2016-09-23 07:19:35 +00:00
* @ return bool
2016-08-03 15:07:34 +00:00
*/
public function child_has_dimensions () {
return false ;
}
2012-08-15 17:08:42 +00:00
/**
* Returns whether or not the product has weight set .
*
* @ return bool
*/
2013-07-23 10:28:59 +00:00
public function has_weight () {
2012-11-21 18:07:45 +00:00
return $this -> get_weight () ? true : false ;
2012-01-10 15:36:14 +00:00
}
2012-08-06 23:33:52 +00:00
2016-08-03 15:07:34 +00:00
/**
* Does a child have a weight set ?
* @ since 2.7 . 0
* @ return boolean
*/
public function child_has_weight () {
return false ;
}
2012-08-15 17:08:42 +00:00
/**
2015-03-24 16:52:26 +00:00
* Returns formatted dimensions .
2012-08-15 17:08:42 +00:00
* @ return string
*/
2013-07-23 10:28:59 +00:00
public function get_dimensions () {
2015-03-24 16:52:26 +00:00
$dimensions = implode ( ' x ' , array_filter ( array (
2016-03-30 12:19:01 +00:00
wc_format_localized_decimal ( $this -> get_length () ),
wc_format_localized_decimal ( $this -> get_width () ),
wc_format_localized_decimal ( $this -> get_height () ),
2015-03-24 16:52:26 +00:00
) ) );
if ( ! empty ( $dimensions ) ) {
$dimensions .= ' ' . get_option ( 'woocommerce_dimension_unit' );
2012-11-29 16:48:40 +00:00
}
2014-08-31 05:49:58 +00:00
2016-08-03 15:07:34 +00:00
return apply_filters ( 'woocommerce_product_dimensions' , $dimensions , $this );
2012-01-10 15:36:14 +00:00
}
2012-08-15 17:08:42 +00:00
/**
* Lists a table of attributes for the product page .
*/
2013-07-23 10:28:59 +00:00
public function list_attributes () {
2013-11-25 12:45:04 +00:00
wc_get_template ( 'single-product/product-attributes.php' , array (
2016-08-27 01:46:45 +00:00
'product' => $this ,
2012-11-21 18:07:45 +00:00
) );
2011-08-09 15:16:18 +00:00
}
2012-08-06 23:33:52 +00:00
2014-08-31 05:49:58 +00:00
/**
* Gets the main product image ID .
*
* @ return int
*/
public function get_image_id () {
2016-09-23 07:19:35 +00:00
if ( has_post_thumbnail ( $this -> get_id () ) ) {
$image_id = get_post_thumbnail_id ( $this -> get_id () );
} elseif ( ( $parent_id = wp_get_post_parent_id ( $this -> get_id () ) ) && has_post_thumbnail ( $parent_id ) ) {
2014-04-08 14:02:11 +00:00
$image_id = get_post_thumbnail_id ( $parent_id );
} else {
$image_id = 0 ;
}
2014-08-31 05:49:58 +00:00
2014-04-08 14:02:11 +00:00
return $image_id ;
2014-08-31 05:49:58 +00:00
}
2014-04-08 14:02:11 +00:00
2014-02-07 17:31:25 +00:00
/**
2015-11-03 12:28:01 +00:00
* Returns the main product image .
2014-02-07 17:31:25 +00:00
*
* @ param string $size ( default : 'shop_thumbnail' )
2016-01-04 11:43:56 +00:00
* @ param array $attr
2016-03-21 14:58:14 +00:00
* @ param bool True to return $placeholder if no image is found , or false to return an empty string .
2014-02-07 17:31:25 +00:00
* @ return string
*/
2016-03-21 14:58:14 +00:00
public function get_image ( $size = 'shop_thumbnail' , $attr = array (), $placeholder = true ) {
2016-09-23 07:19:35 +00:00
if ( has_post_thumbnail ( $this -> get_id () ) ) {
$image = get_the_post_thumbnail ( $this -> get_id (), $size , $attr );
} elseif ( ( $parent_id = wp_get_post_parent_id ( $this -> get_id () ) ) && has_post_thumbnail ( $parent_id ) ) {
2012-11-28 18:02:12 +00:00
$image = get_the_post_thumbnail ( $parent_id , $size , $attr );
2016-03-21 14:58:14 +00:00
} elseif ( $placeholder ) {
2013-11-25 13:56:59 +00:00
$image = wc_placeholder_img ( $size );
2016-03-21 14:58:14 +00:00
} else {
$image = '' ;
2012-06-29 16:51:15 +00:00
}
2016-09-12 12:03:44 +00:00
return str_replace ( array ( 'https://' , 'http://' ), '//' , $image );
2014-02-07 17:31:25 +00:00
}
2013-03-27 07:57:26 +00:00
/**
2013-03-27 08:06:59 +00:00
* Get product name with SKU or ID . Used within admin .
2013-03-27 07:57:26 +00:00
*
2013-03-27 08:06:59 +00:00
* @ return string Formatted product name
2013-03-27 07:57:26 +00:00
*/
2013-07-23 10:28:59 +00:00
public function get_formatted_name () {
2013-11-24 10:42:36 +00:00
if ( $this -> get_sku () ) {
2013-03-27 07:57:26 +00:00
$identifier = $this -> get_sku ();
2013-11-24 10:42:36 +00:00
} else {
2016-09-23 07:19:35 +00:00
$identifier = '#' . $this -> get_id ();
2013-11-24 10:42:36 +00:00
}
2013-03-27 07:57:26 +00:00
2016-04-25 12:07:38 +00:00
return sprintf ( '%s – %s' , $identifier , $this -> get_title () );
2013-03-27 07:57:26 +00:00
}
2015-03-27 16:28:26 +00:00
/**
2015-11-03 12:28:01 +00:00
* Retrieves related product terms .
2015-03-27 16:28:26 +00:00
*
* @ param string $term
* @ return array
*/
protected function get_related_terms ( $term ) {
2016-08-27 02:23:54 +00:00
$terms_array = array ( 0 );
2015-03-27 16:28:26 +00:00
2016-09-23 07:19:35 +00:00
$terms = apply_filters ( 'woocommerce_get_related_' . $term . '_terms' , wp_get_post_terms ( $this -> get_id (), $term ), $this -> get_id () );
2015-03-27 16:28:26 +00:00
foreach ( $terms as $term ) {
$terms_array [] = $term -> term_id ;
}
return array_map ( 'absint' , $terms_array );
}
/**
2015-11-03 12:28:01 +00:00
* Builds the related posts query .
2015-03-27 16:28:26 +00:00
*
* @ param array $cats_array
* @ param array $tags_array
* @ param array $exclude_ids
* @ param int $limit
* @ return string
*/
protected function build_related_query ( $cats_array , $tags_array , $exclude_ids , $limit ) {
global $wpdb ;
$limit = absint ( $limit );
$query = array ();
$query [ 'fields' ] = " SELECT DISTINCT ID FROM { $wpdb -> posts } p " ;
$query [ 'join' ] = " INNER JOIN { $wpdb -> postmeta } pm ON ( pm.post_id = p.ID AND pm.meta_key='_visibility' ) " ;
$query [ 'join' ] .= " INNER JOIN { $wpdb -> term_relationships } tr ON (p.ID = tr.object_id) " ;
$query [ 'join' ] .= " INNER JOIN { $wpdb -> term_taxonomy } tt ON (tr.term_taxonomy_id = tt.term_taxonomy_id) " ;
$query [ 'join' ] .= " INNER JOIN { $wpdb -> terms } t ON (t.term_id = tt.term_id) " ;
if ( get_option ( 'woocommerce_hide_out_of_stock_items' ) === 'yes' ) {
$query [ 'join' ] .= " INNER JOIN { $wpdb -> postmeta } pm2 ON ( pm2.post_id = p.ID AND pm2.meta_key='_stock_status' ) " ;
}
$query [ 'where' ] = " WHERE 1=1 " ;
$query [ 'where' ] .= " AND p.post_status = 'publish' " ;
$query [ 'where' ] .= " AND p.post_type = 'product' " ;
$query [ 'where' ] .= " AND p.ID NOT IN ( " . implode ( ',' , $exclude_ids ) . " ) " ;
$query [ 'where' ] .= " AND pm.meta_value IN ( 'visible', 'catalog' ) " ;
if ( get_option ( 'woocommerce_hide_out_of_stock_items' ) === 'yes' ) {
$query [ 'where' ] .= " AND pm2.meta_value = 'instock' " ;
}
2016-09-23 07:19:35 +00:00
$relate_by_category = apply_filters ( 'woocommerce_product_related_posts_relate_by_category' , true , $this -> get_id () );
$relate_by_tag = apply_filters ( 'woocommerce_product_related_posts_relate_by_tag' , true , $this -> get_id () );
2016-03-17 16:02:33 +00:00
if ( $relate_by_category || $relate_by_tag ) {
$query [ 'where' ] .= ' AND (' ;
if ( $relate_by_category ) {
$query [ 'where' ] .= " ( tt.taxonomy = 'product_cat' AND t.term_id IN ( " . implode ( ',' , $cats_array ) . " ) ) " ;
2016-03-17 17:54:09 +00:00
if ( $relate_by_tag ) {
$query [ 'where' ] .= ' OR ' ;
}
2016-03-17 16:02:33 +00:00
}
if ( $relate_by_tag ) {
2016-03-17 17:54:09 +00:00
$query [ 'where' ] .= " ( tt.taxonomy = 'product_tag' AND t.term_id IN ( " . implode ( ',' , $tags_array ) . " ) ) " ;
2016-03-17 16:02:33 +00:00
}
2015-03-27 16:28:26 +00:00
2016-03-17 16:02:33 +00:00
$query [ 'where' ] .= ')' ;
2015-03-27 16:28:26 +00:00
}
2015-05-25 14:40:13 +00:00
$query [ 'limits' ] = " LIMIT { $limit } " ;
2016-09-23 07:19:35 +00:00
$query = apply_filters ( 'woocommerce_product_related_posts_query' , $query , $this -> get_id () );
2015-03-27 16:28:26 +00:00
return $query ;
}
2016-09-29 23:02:50 +00:00
/**
* Save taxonomy terms .
*
* @ since 2.7 . 0
* @ param array $terms_id Terms ID .
* @ param string $taxonomy Taxonomy .
* @ return array | WP_Error
*/
protected function save_taxonomy_terms ( $terms_id , $taxonomy = 'cat' ) {
$terms_id = array_unique ( array_map ( 'intval' , $terms_id ) );
return wp_set_object_terms ( $this -> get_id (), $terms_id , 'product_' . $taxonomy );
}
2013-12-02 11:34:27 +00:00
}