1664 lines
46 KiB
PHP
1664 lines
46 KiB
PHP
<?php
|
|
/**
|
|
* Abstract Product Class
|
|
*
|
|
* The WooCommerce product class handles individual product data.
|
|
*
|
|
* @class WC_Product
|
|
* @var WP_Post
|
|
* @version 2.1.0
|
|
* @package WooCommerce/Abstracts
|
|
* @category Abstract Class
|
|
* @author WooThemes
|
|
*
|
|
* @property string $width Product width
|
|
* @property string $length Product length
|
|
* @property string $height Product height
|
|
* @property string $weight Product weight
|
|
* @property string $price Product price
|
|
* @property string $regular_price Product regular price
|
|
* @property string $sale_price Product sale price
|
|
* @property string $product_image_gallery String of image IDs in the gallery
|
|
* @property string $sku Product SKU
|
|
* @property string $stock Stock amount
|
|
* @property string $downloadable Shows/define if the product is downloadable
|
|
* @property string $virtual Shows/define if the product is virtual
|
|
* @property string $sold_individually Allow one item to be bought in a single order
|
|
* @property string $tax_status Tax status
|
|
* @property string $tax_class Tax class
|
|
* @property string $manage_stock Shows/define if can manage the product stock
|
|
* @property string $stock_status Stock status
|
|
* @property string $backorders Whether or not backorders are allowed
|
|
* @property string $featured Featured product
|
|
* @property string $visibility Product visibility
|
|
* @property string $variation_id Variation ID when dealing with variations
|
|
*/
|
|
class WC_Product {
|
|
|
|
/**
|
|
* The product (post) ID.
|
|
*
|
|
* @var int
|
|
*/
|
|
public $id = 0;
|
|
|
|
/**
|
|
* $post Stores post data.
|
|
*
|
|
* @var $post WP_Post
|
|
*/
|
|
public $post = null;
|
|
|
|
/**
|
|
* The product's type (simple, variable etc).
|
|
*
|
|
* @var string
|
|
*/
|
|
public $product_type = null;
|
|
|
|
/**
|
|
* Product shipping class.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $shipping_class = '';
|
|
|
|
/**
|
|
* ID of the shipping class this product has.
|
|
*
|
|
* @var int
|
|
*/
|
|
protected $shipping_class_id = 0;
|
|
|
|
/** @public string The product's total stock, including that of its children. */
|
|
public $total_stock;
|
|
|
|
/**
|
|
* Supported features such as 'ajax_add_to_cart'.
|
|
* @var array
|
|
*/
|
|
protected $supports = array();
|
|
|
|
/**
|
|
* Constructor gets the post object and sets the ID for the loaded product.
|
|
*
|
|
* @param int|WC_Product|object $product Product ID, post object, or product object
|
|
*/
|
|
public function __construct( $product ) {
|
|
if ( is_numeric( $product ) ) {
|
|
$this->id = absint( $product );
|
|
$this->post = get_post( $this->id );
|
|
} elseif ( $product instanceof WC_Product ) {
|
|
$this->id = absint( $product->id );
|
|
$this->post = $product->post;
|
|
} elseif ( isset( $product->ID ) ) {
|
|
$this->id = absint( $product->ID );
|
|
$this->post = $product;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* __isset function.
|
|
*
|
|
* @param mixed $key
|
|
* @return bool
|
|
*/
|
|
public function __isset( $key ) {
|
|
return metadata_exists( 'post', $this->id, '_' . $key );
|
|
}
|
|
|
|
/**
|
|
* __get function.
|
|
*
|
|
* @param string $key
|
|
* @return mixed
|
|
*/
|
|
public function __get( $key ) {
|
|
$value = get_post_meta( $this->id, '_' . $key, true );
|
|
|
|
// Get values or default if not set
|
|
if ( in_array( $key, array( 'downloadable', 'virtual', 'backorders', 'manage_stock', 'featured', 'sold_individually' ) ) ) {
|
|
$value = $value ? $value : 'no';
|
|
|
|
} elseif ( in_array( $key, array( 'product_attributes', 'crosssell_ids', 'upsell_ids' ) ) ) {
|
|
$value = $value ? $value : array();
|
|
|
|
} elseif ( 'visibility' === $key ) {
|
|
$value = $value ? $value : 'hidden';
|
|
|
|
} elseif ( 'stock' === $key ) {
|
|
$value = $value ? $value : 0;
|
|
|
|
} elseif ( 'stock_status' === $key ) {
|
|
$value = $value ? $value : 'instock';
|
|
|
|
} elseif ( 'tax_status' === $key ) {
|
|
$value = $value ? $value : 'taxable';
|
|
|
|
}
|
|
|
|
if ( false !== $value ) {
|
|
$this->$key = $value;
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Get the product's post data.
|
|
*
|
|
* @return object
|
|
*/
|
|
public function get_post_data() {
|
|
return $this->post;
|
|
}
|
|
|
|
/**
|
|
* Check if a product supports a given feature.
|
|
*
|
|
* 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
|
|
*/
|
|
public function supports( $feature ) {
|
|
return apply_filters( 'woocommerce_product_supports', in_array( $feature, $this->supports ) ? true : false, $feature, $this );
|
|
}
|
|
|
|
/**
|
|
* Return the product ID
|
|
*
|
|
* @since 2.5.0
|
|
* @return int product (post) ID
|
|
*/
|
|
public function get_id() {
|
|
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* Returns the gallery attachment ids.
|
|
*
|
|
* @return array
|
|
*/
|
|
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 );
|
|
}
|
|
|
|
/**
|
|
* Wrapper for get_permalink.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_permalink() {
|
|
return get_permalink( $this->id );
|
|
}
|
|
|
|
/**
|
|
* Get SKU (Stock-keeping unit) - product unique ID.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_sku() {
|
|
return apply_filters( 'woocommerce_get_sku', $this->sku, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns number of items available for sale.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_stock_quantity() {
|
|
return apply_filters( 'woocommerce_get_stock_quantity', $this->managing_stock() ? wc_stock_amount( $this->stock ) : null, $this );
|
|
}
|
|
|
|
/**
|
|
* Get total stock - This is the stock of parent and children combined.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_total_stock() {
|
|
if ( empty( $this->total_stock ) ) {
|
|
if ( sizeof( $this->get_children() ) > 0 ) {
|
|
$this->total_stock = max( 0, $this->get_stock_quantity() );
|
|
|
|
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 ) );
|
|
}
|
|
}
|
|
} else {
|
|
$this->total_stock = $this->get_stock_quantity();
|
|
}
|
|
}
|
|
return wc_stock_amount( $this->total_stock );
|
|
}
|
|
|
|
/**
|
|
* Check if the stock status needs changing.
|
|
*/
|
|
public function check_stock_status() {
|
|
if ( ! $this->backorders_allowed() && $this->get_total_stock() <= get_option( 'woocommerce_notify_no_stock_amount' ) ) {
|
|
if ( $this->stock_status !== 'outofstock' ) {
|
|
$this->set_stock_status( 'outofstock' );
|
|
}
|
|
} elseif ( $this->backorders_allowed() || $this->get_total_stock() > get_option( 'woocommerce_notify_no_stock_amount' ) ) {
|
|
if ( $this->stock_status !== 'instock' ) {
|
|
$this->set_stock_status( 'instock' );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set stock level of the product.
|
|
*
|
|
* Uses queries rather than update_post_meta so we can do this in one query (to avoid stock issues).
|
|
* We cannot rely on the original loaded value in case another order was made since then.
|
|
*
|
|
* @param int $amount (default: null)
|
|
* @param string $mode can be set, add, or subtract
|
|
* @return int new stock level
|
|
*/
|
|
public function set_stock( $amount = null, $mode = 'set' ) {
|
|
global $wpdb;
|
|
|
|
if ( ! is_null( $amount ) && $this->managing_stock() ) {
|
|
|
|
// Ensure key exists
|
|
add_post_meta( $this->id, '_stock', 0, true );
|
|
|
|
// Update stock in DB directly
|
|
switch ( $mode ) {
|
|
case 'add' :
|
|
$wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->postmeta} SET meta_value = meta_value + %f WHERE post_id = %d AND meta_key='_stock'", $amount, $this->id ) );
|
|
break;
|
|
case 'subtract' :
|
|
$wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->postmeta} SET meta_value = meta_value - %f WHERE post_id = %d AND meta_key='_stock'", $amount, $this->id ) );
|
|
break;
|
|
default :
|
|
$wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->postmeta} SET meta_value = %f WHERE post_id = %d AND meta_key='_stock'", $amount, $this->id ) );
|
|
break;
|
|
}
|
|
|
|
// Clear caches
|
|
wp_cache_delete( $this->id, 'post_meta' );
|
|
delete_transient( 'wc_low_stock_count' );
|
|
delete_transient( 'wc_outofstock_count' );
|
|
unset( $this->stock );
|
|
|
|
// Stock status
|
|
$this->check_stock_status();
|
|
|
|
// Trigger action
|
|
do_action( 'woocommerce_product_set_stock', $this );
|
|
}
|
|
|
|
return $this->get_stock_quantity();
|
|
}
|
|
|
|
/**
|
|
* Reduce stock level of the product.
|
|
*
|
|
* @param int $amount Amount to reduce by. Default: 1
|
|
* @return int new stock level
|
|
*/
|
|
public function reduce_stock( $amount = 1 ) {
|
|
return $this->set_stock( $amount, 'subtract' );
|
|
}
|
|
|
|
/**
|
|
* Increase stock level of the product.
|
|
*
|
|
* @param int $amount Amount to increase by. Default 1.
|
|
* @return int new stock level
|
|
*/
|
|
public function increase_stock( $amount = 1 ) {
|
|
return $this->set_stock( $amount, 'add' );
|
|
}
|
|
|
|
/**
|
|
* Set stock status of the product.
|
|
*
|
|
* @param string $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->id, '_stock_status', $status ) ) {
|
|
$this->stock_status = $status;
|
|
do_action( 'woocommerce_product_set_stock_status', $this->id, $status );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the product type.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_type() {
|
|
return is_null( $this->product_type ) ? '' : $this->product_type;
|
|
}
|
|
|
|
/**
|
|
* Checks the product type.
|
|
*
|
|
* Backwards compat with downloadable/virtual.
|
|
*
|
|
* @param string $type Array or string of types
|
|
* @return bool
|
|
*/
|
|
public 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.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_downloadable() {
|
|
return $this->downloadable == 'yes' ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Check if downloadable product has a file attached.
|
|
*
|
|
* @since 1.6.2
|
|
*
|
|
* @param string $download_id file identifier
|
|
* @return bool Whether downloadable product has a file attached.
|
|
*/
|
|
public function has_file( $download_id = '' ) {
|
|
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() {
|
|
|
|
$downloadable_files = array_filter( isset( $this->downloadable_files ) ? (array) maybe_unserialize( $this->downloadable_files ) : array() );
|
|
|
|
if ( ! empty( $downloadable_files ) ) {
|
|
|
|
foreach ( $downloadable_files as $key => $file ) {
|
|
|
|
if ( ! is_array( $file ) ) {
|
|
$downloadable_files[ $key ] = array(
|
|
'file' => $file,
|
|
'name' => ''
|
|
);
|
|
}
|
|
|
|
// Set default name
|
|
if ( empty( $file['name'] ) ) {
|
|
$downloadable_files[ $key ]['name'] = wc_get_filename_from_url( $file['file'] );
|
|
}
|
|
|
|
// Filter URL
|
|
$downloadable_files[ $key ]['file'] = apply_filters( 'woocommerce_file_download_path', $downloadable_files[ $key ]['file'], $this, $key );
|
|
}
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_product_files', $downloadable_files, $this );
|
|
}
|
|
|
|
/**
|
|
* Get a file by $download_id.
|
|
*
|
|
* @param string $download_id file identifier
|
|
* @return array|false if not found
|
|
*/
|
|
public function get_file( $download_id = '' ) {
|
|
|
|
$files = $this->get_files();
|
|
|
|
if ( '' === $download_id ) {
|
|
$file = sizeof( $files ) ? current( $files ) : false;
|
|
} elseif ( isset( $files[ $download_id ] ) ) {
|
|
$file = $files[ $download_id ];
|
|
} else {
|
|
$file = false;
|
|
}
|
|
|
|
// allow overriding based on the particular file being requested
|
|
return apply_filters( 'woocommerce_product_file', $file, $this, $download_id );
|
|
}
|
|
|
|
/**
|
|
* Get file download path identified by $download_id.
|
|
*
|
|
* @param string $download_id file identifier
|
|
* @return string
|
|
*/
|
|
public function get_file_download_path( $download_id ) {
|
|
$files = $this->get_files();
|
|
|
|
if ( isset( $files[ $download_id ] ) ) {
|
|
$file_path = $files[ $download_id ]['file'];
|
|
} else {
|
|
$file_path = '';
|
|
}
|
|
|
|
// allow overriding based on the particular file being requested
|
|
return apply_filters( 'woocommerce_product_file_download_path', $file_path, $this, $download_id );
|
|
}
|
|
|
|
/**
|
|
* Checks if a product is virtual (has no shipping).
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_virtual() {
|
|
return apply_filters( 'woocommerce_is_virtual', $this->virtual == 'yes' ? true : false, $this );
|
|
}
|
|
|
|
/**
|
|
* Checks if a product needs shipping.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function needs_shipping() {
|
|
return apply_filters( 'woocommerce_product_needs_shipping', $this->is_virtual() ? false : true, $this );
|
|
}
|
|
|
|
/**
|
|
* Check if a product is sold individually (no quantities).
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_sold_individually() {
|
|
|
|
$return = false;
|
|
|
|
if ( 'yes' == $this->sold_individually ) {
|
|
$return = true;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_is_sold_individually', $return, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the child product.
|
|
*
|
|
* @param mixed $child_id
|
|
* @return WC_Product|WC_Product|WC_Product_variation
|
|
*/
|
|
public function get_child( $child_id ) {
|
|
return wc_get_product( $child_id );
|
|
}
|
|
|
|
/**
|
|
* Returns the children.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_children() {
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product has any child product.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function has_child() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product post exists.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function exists() {
|
|
return empty( $this->post ) ? false : true;
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product is taxable.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_taxable() {
|
|
$taxable = $this->get_tax_status() === 'taxable' && wc_tax_enabled() ? true : false;
|
|
return apply_filters( 'woocommerce_product_is_taxable', $taxable, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product shipping is taxable.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_shipping_taxable() {
|
|
return $this->get_tax_status() === 'taxable' || $this->get_tax_status() === 'shipping' ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Get the title of the post.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_title() {
|
|
return apply_filters( 'woocommerce_product_title', $this->post ? $this->post->post_title : '', $this );
|
|
}
|
|
|
|
/**
|
|
* Get the parent of the post.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_parent() {
|
|
return apply_filters( 'woocommerce_product_parent', absint( $this->post->post_parent ), $this );
|
|
}
|
|
|
|
/**
|
|
* Get the add to url used mainly in loops.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function add_to_cart_url() {
|
|
return apply_filters( 'woocommerce_product_add_to_cart_url', get_permalink( $this->id ), $this );
|
|
}
|
|
|
|
/**
|
|
* Get the add to cart button text for the single page.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function single_add_to_cart_text() {
|
|
return apply_filters( 'woocommerce_product_single_add_to_cart_text', __( 'Add to cart', 'woocommerce' ), $this );
|
|
}
|
|
|
|
/**
|
|
* Get the add to cart button text.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function add_to_cart_text() {
|
|
return apply_filters( 'woocommerce_product_add_to_cart_text', __( 'Read more', 'woocommerce' ), $this );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product is stock managed.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public 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.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_in_stock() {
|
|
return apply_filters( 'woocommerce_product_is_in_stock', $this->stock_status === 'instock', $this );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product can be backordered.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function backorders_allowed() {
|
|
return apply_filters( 'woocommerce_product_backorders_allowed', $this->backorders === 'yes' || $this->backorders === 'notify' ? true : false, $this->id, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product needs to notify the customer on backorder.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function backorders_require_notification() {
|
|
return apply_filters( 'woocommerce_product_backorders_require_notification', $this->managing_stock() && $this->backorders === 'notify' ? true : false, $this );
|
|
}
|
|
|
|
/**
|
|
* Check if a product is on backorder.
|
|
*
|
|
* @param int $qty_in_cart (default: 0)
|
|
* @return bool
|
|
*/
|
|
public 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.
|
|
*
|
|
* @param mixed $quantity
|
|
* @return bool
|
|
*/
|
|
public function has_enough_stock( $quantity ) {
|
|
return ! $this->managing_stock() || $this->backorders_allowed() || $this->get_stock_quantity() >= $quantity ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Returns the availability of the product.
|
|
*
|
|
* 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.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_availability() {
|
|
return apply_filters( 'woocommerce_get_availability', array(
|
|
'availability' => $this->get_availability_text(),
|
|
'class' => $this->get_availability_class(),
|
|
), $this );
|
|
}
|
|
|
|
/**
|
|
* Get availability text based on stock status.
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function get_availability_text() {
|
|
if ( ! $this->is_in_stock() ) {
|
|
$availability = __( 'Out of stock', 'woocommerce' );
|
|
} elseif ( $this->managing_stock() && $this->is_on_backorder( 1 ) ) {
|
|
$availability = $this->backorders_require_notification() ? __( 'Available on backorder', 'woocommerce' ) : __( 'In stock', 'woocommerce' );
|
|
} 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' ) ) {
|
|
$availability = sprintf( __( 'Only %s left in stock', 'woocommerce' ), $this->get_total_stock() );
|
|
|
|
if ( $this->backorders_allowed() && $this->backorders_require_notification() ) {
|
|
$availability .= ' ' . __( '(also available on backorder)', 'woocommerce' );
|
|
}
|
|
} else {
|
|
$availability = __( 'In stock', 'woocommerce' );
|
|
}
|
|
break;
|
|
default :
|
|
$availability = sprintf( __( '%s in stock', 'woocommerce' ), $this->get_total_stock() );
|
|
|
|
if ( $this->backorders_allowed() && $this->backorders_require_notification() ) {
|
|
$availability .= ' ' . __( '(also available on backorder)', 'woocommerce' );
|
|
}
|
|
break;
|
|
}
|
|
} else {
|
|
$availability = '';
|
|
}
|
|
return apply_filters( 'woocommerce_get_availability_text', $availability, $this );
|
|
}
|
|
|
|
/**
|
|
* Get availability classname based on stock status.
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function get_availability_class() {
|
|
if ( ! $this->is_in_stock() ) {
|
|
$class = 'out-of-stock';
|
|
} elseif ( $this->managing_stock() && $this->is_on_backorder( 1 ) && $this->backorders_require_notification() ) {
|
|
$class = 'available-on-backorder';
|
|
} else {
|
|
$class = 'in-stock';
|
|
}
|
|
return apply_filters( 'woocommerce_get_availability_class', $class, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product is featured.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_featured() {
|
|
return $this->featured === 'yes' ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product is visible in the catalog.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_visible() {
|
|
if ( ! $this->post ) {
|
|
$visible = false;
|
|
|
|
// Published/private
|
|
} elseif ( $this->post->post_status !== 'publish' && ! current_user_can( 'edit_post', $this->id ) ) {
|
|
$visible = false;
|
|
|
|
// Out of stock visibility
|
|
} elseif ( 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) && ! $this->is_in_stock() ) {
|
|
$visible = false;
|
|
|
|
// visibility setting
|
|
} elseif ( 'hidden' === $this->visibility ) {
|
|
$visible = false;
|
|
} elseif ( 'visible' === $this->visibility ) {
|
|
$visible = true;
|
|
|
|
// Visibility in loop
|
|
} elseif ( is_search() ) {
|
|
$visible = 'search' === $this->visibility;
|
|
} else {
|
|
$visible = 'catalog' === $this->visibility;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_product_is_visible', $visible, $this->id );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product is on sale.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_on_sale() {
|
|
return apply_filters( 'woocommerce_product_is_on_sale', ( $this->get_sale_price() !== $this->get_regular_price() && $this->get_sale_price() === $this->get_price() ), $this );
|
|
}
|
|
|
|
/**
|
|
* Returns false if the product cannot be bought.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public 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;
|
|
|
|
// Check the product is published
|
|
} elseif ( $this->post->post_status !== 'publish' && ! current_user_can( 'edit_post', $this->id ) ) {
|
|
$purchasable = false;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_is_purchasable', $purchasable, $this );
|
|
}
|
|
|
|
/**
|
|
* Set a products price dynamically.
|
|
*
|
|
* @param float $price Price to set.
|
|
*/
|
|
public function set_price( $price ) {
|
|
$this->price = $price;
|
|
}
|
|
|
|
/**
|
|
* Adjust a products price dynamically.
|
|
*
|
|
* @param mixed $price
|
|
*/
|
|
public function adjust_price( $price ) {
|
|
$this->price = $this->price + $price;
|
|
}
|
|
|
|
/**
|
|
* Returns the product's sale price.
|
|
*
|
|
* @return string price
|
|
*/
|
|
public function get_sale_price() {
|
|
return apply_filters( 'woocommerce_get_sale_price', $this->sale_price, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the product's regular price.
|
|
*
|
|
* @return string price
|
|
*/
|
|
public function get_regular_price() {
|
|
return apply_filters( 'woocommerce_get_regular_price', $this->regular_price, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the product's active price.
|
|
*
|
|
* @return string price
|
|
*/
|
|
public function get_price() {
|
|
return apply_filters( 'woocommerce_get_price', $this->price, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the price (including tax). Uses customer tax rates. Can work for a specific $qty for more accurate taxes.
|
|
*
|
|
* @param int $qty
|
|
* @param string $price to calculate, left blank to just use get_price()
|
|
* @return string
|
|
*/
|
|
public function get_price_including_tax( $qty = 1, $price = '' ) {
|
|
|
|
if ( $price === '' ) {
|
|
$price = $this->get_price();
|
|
}
|
|
|
|
if ( $this->is_taxable() ) {
|
|
|
|
if ( get_option( 'woocommerce_prices_include_tax' ) === 'no' ) {
|
|
|
|
$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 );
|
|
$price = round( $price * $qty + $tax_amount, wc_get_price_decimals() );
|
|
|
|
} else {
|
|
|
|
$tax_rates = WC_Tax::get_rates( $this->get_tax_class() );
|
|
$base_tax_rates = WC_Tax::get_base_tax_rates( $this->tax_class );
|
|
|
|
if ( ! empty( WC()->customer ) && WC()->customer->get_is_vat_exempt() ) {
|
|
|
|
$base_taxes = WC_Tax::calc_tax( $price * $qty, $base_tax_rates, true );
|
|
$base_tax_amount = array_sum( $base_taxes );
|
|
$price = round( $price * $qty - $base_tax_amount, wc_get_price_decimals() );
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
} elseif ( $tax_rates !== $base_tax_rates && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
|
|
|
|
$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 );
|
|
$price = round( ( $price * $qty ) - array_sum( $base_taxes ) + array_sum( $modded_taxes ), wc_get_price_decimals() );
|
|
|
|
} else {
|
|
|
|
$price = $price * $qty;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
$price = $price * $qty;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_get_price_including_tax', $price, $qty, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the price (excluding tax) - ignores tax_class filters since the price may *include* tax and thus needs subtracting.
|
|
* Uses store base tax rates. Can work for a specific $qty for more accurate taxes.
|
|
*
|
|
* @param int $qty
|
|
* @param string $price to calculate, left blank to just use get_price()
|
|
* @return string
|
|
*/
|
|
public function get_price_excluding_tax( $qty = 1, $price = '' ) {
|
|
|
|
if ( $price === '' ) {
|
|
$price = $this->get_price();
|
|
}
|
|
|
|
if ( $this->is_taxable() && 'yes' === get_option( 'woocommerce_prices_include_tax' ) ) {
|
|
$tax_rates = WC_Tax::get_base_tax_rates( $this->tax_class );
|
|
$taxes = WC_Tax::calc_tax( $price * $qty, $tax_rates, true );
|
|
$price = WC_Tax::round( $price * $qty - array_sum( $taxes ) );
|
|
} else {
|
|
$price = $price * $qty;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_get_price_excluding_tax', $price, $qty, $this );
|
|
}
|
|
|
|
/**
|
|
* 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 ) {
|
|
|
|
if ( $price === '' ) {
|
|
$price = $this->get_price();
|
|
}
|
|
|
|
$tax_display_mode = get_option( 'woocommerce_tax_display_shop' );
|
|
$display_price = $tax_display_mode == 'incl' ? $this->get_price_including_tax( $qty, $price ) : $this->get_price_excluding_tax( $qty, $price );
|
|
|
|
return $display_price;
|
|
}
|
|
|
|
/**
|
|
* Get the suffix to display after prices > 0.
|
|
*
|
|
* @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_price_suffix( $price = '', $qty = 1 ) {
|
|
|
|
if ( $price === '' ) {
|
|
$price = $this->get_price();
|
|
}
|
|
|
|
$price_display_suffix = get_option( 'woocommerce_price_display_suffix' );
|
|
|
|
if ( $price_display_suffix ) {
|
|
|
|
$price_display_suffix = ' <small class="woocommerce-price-suffix">' . $price_display_suffix . '</small>';
|
|
|
|
$find = array(
|
|
'{price_including_tax}',
|
|
'{price_excluding_tax}'
|
|
);
|
|
|
|
$replace = array(
|
|
wc_price( $this->get_price_including_tax( $qty, $price ) ),
|
|
wc_price( $this->get_price_excluding_tax( $qty, $price ) )
|
|
);
|
|
|
|
$price_display_suffix = str_replace( $find, $replace, $price_display_suffix );
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_get_price_suffix', $price_display_suffix, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the price in html format.
|
|
*
|
|
* @param string $price (default: '')
|
|
* @return string
|
|
*/
|
|
public function get_price_html( $price = '' ) {
|
|
|
|
$display_price = $this->get_display_price();
|
|
$display_regular_price = $this->get_display_price( $this->get_regular_price() );
|
|
|
|
if ( $this->get_price() > 0 ) {
|
|
|
|
if ( $this->is_on_sale() && $this->get_regular_price() ) {
|
|
|
|
$price .= $this->get_price_html_from_to( $display_regular_price, $display_price ) . $this->get_price_suffix();
|
|
|
|
$price = apply_filters( 'woocommerce_sale_price_html', $price, $this );
|
|
|
|
} else {
|
|
|
|
$price .= wc_price( $display_price ) . $this->get_price_suffix();
|
|
|
|
$price = apply_filters( 'woocommerce_price_html', $price, $this );
|
|
|
|
}
|
|
|
|
} elseif ( $this->get_price() === '' ) {
|
|
|
|
$price = apply_filters( 'woocommerce_empty_price_html', '', $this );
|
|
|
|
} elseif ( $this->get_price() == 0 ) {
|
|
|
|
if ( $this->is_on_sale() && $this->get_regular_price() ) {
|
|
|
|
$price .= $this->get_price_html_from_to( $display_regular_price, __( 'Free!', 'woocommerce' ) );
|
|
|
|
$price = apply_filters( 'woocommerce_free_sale_price_html', $price, $this );
|
|
|
|
} else {
|
|
|
|
$price = '<span class="amount">' . __( 'Free!', 'woocommerce' ) . '</span>';
|
|
|
|
$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.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_price_html_from_text() {
|
|
$from = '<span class="from">' . _x( 'From:', 'min_price', 'woocommerce' ) . ' </span>';
|
|
|
|
return apply_filters( 'woocommerce_get_price_html_from_text', $from, $this );
|
|
}
|
|
|
|
/**
|
|
* Functions for getting parts of a price, in html, used by get_price_html.
|
|
*
|
|
* @param string $from String or float to wrap with 'from' text
|
|
* @param mixed $to String or float to wrap with 'to' text
|
|
* @return string
|
|
*/
|
|
public function get_price_html_from_to( $from, $to ) {
|
|
$price = '<del>' . ( ( is_numeric( $from ) ) ? wc_price( $from ) : $from ) . '</del> <ins>' . ( ( is_numeric( $to ) ) ? wc_price( $to ) : $to ) . '</ins>';
|
|
|
|
return apply_filters( 'woocommerce_get_price_html_from_to', $price, $from, $to, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the tax class.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_tax_class() {
|
|
return apply_filters( 'woocommerce_product_tax_class', $this->tax_class, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the tax status.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_tax_status() {
|
|
return $this->tax_status;
|
|
}
|
|
|
|
/**
|
|
* Get the average rating of product. This is calculated once and stored in postmeta.
|
|
* @return string
|
|
*/
|
|
public function get_average_rating() {
|
|
// No meta data? Do the calculation
|
|
if ( ! metadata_exists( 'post', $this->id, '_wc_average_rating' ) ) {
|
|
$this->sync_average_rating( $this->id );
|
|
}
|
|
|
|
return (string) floatval( get_post_meta( $this->id, '_wc_average_rating', true ) );
|
|
}
|
|
|
|
/**
|
|
* Get the total amount (COUNT) of ratings.
|
|
* @param int $value Optional. Rating value to get the count for. By default returns the count of all rating values.
|
|
* @return int
|
|
*/
|
|
public function get_rating_count( $value = null ) {
|
|
// No meta data? Do the calculation
|
|
if ( ! metadata_exists( 'post', $this->id, '_wc_rating_count' ) ) {
|
|
$this->sync_rating_count( $this->id );
|
|
}
|
|
|
|
$counts = get_post_meta( $this->id, '_wc_rating_count', true );
|
|
|
|
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
|
|
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
|
|
", $post_id ) );
|
|
$average = number_format( $ratings / $count, 2, '.', '' );
|
|
} else {
|
|
$average = 0;
|
|
}
|
|
update_post_meta( $post_id, '_wc_average_rating', $average );
|
|
}
|
|
|
|
/**
|
|
* Sync product rating count. Can be called statically.
|
|
* @param int $post_id
|
|
*/
|
|
public static function sync_rating_count( $post_id ) {
|
|
global $wpdb;
|
|
|
|
$counts = array();
|
|
$raw_counts = $wpdb->get_results( $wpdb->prepare( "
|
|
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;
|
|
}
|
|
|
|
update_post_meta( $post_id, '_wc_rating_count', $counts );
|
|
}
|
|
|
|
/**
|
|
* Returns the product rating in html format.
|
|
*
|
|
* @param string $rating (default: '')
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_rating_html( $rating = null ) {
|
|
$rating_html = '';
|
|
|
|
if ( ! is_numeric( $rating ) ) {
|
|
$rating = $this->get_average_rating();
|
|
}
|
|
|
|
if ( $rating > 0 ) {
|
|
|
|
$rating_html = '<div class="star-rating" title="' . sprintf( __( 'Rated %s out of 5', 'woocommerce' ), $rating ) . '">';
|
|
|
|
$rating_html .= '<span style="width:' . ( ( $rating / 5 ) * 100 ) . '%"><strong class="rating">' . $rating . '</strong> ' . __( 'out of 5', 'woocommerce' ) . '</span>';
|
|
|
|
$rating_html .= '</div>';
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_product_get_rating_html', $rating_html, $rating );
|
|
}
|
|
|
|
/**
|
|
* Get the total amount (COUNT) of reviews.
|
|
*
|
|
* @since 2.3.2
|
|
* @return int The total numver of product reviews
|
|
*/
|
|
public function get_review_count() {
|
|
global $wpdb;
|
|
|
|
// No meta date? Do the calculation
|
|
if ( ! metadata_exists( 'post', $this->id, '_wc_review_count' ) ) {
|
|
$count = $wpdb->get_var( $wpdb->prepare("
|
|
SELECT COUNT(*) FROM $wpdb->comments
|
|
WHERE comment_parent = 0
|
|
AND comment_post_ID = %d
|
|
AND comment_approved = '1'
|
|
", $this->id ) );
|
|
|
|
update_post_meta( $this->id, '_wc_review_count', $count );
|
|
} else {
|
|
$count = get_post_meta( $this->id, '_wc_review_count', true );
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_product_review_count', $count, $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the upsell product ids.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_upsells() {
|
|
return apply_filters( 'woocommerce_product_upsell_ids', (array) maybe_unserialize( $this->upsell_ids ), $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the cross sell product ids.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_cross_sells() {
|
|
return apply_filters( 'woocommerce_product_crosssell_ids', (array) maybe_unserialize( $this->crosssell_ids ), $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the product categories.
|
|
*
|
|
* @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->id, 'product_cat', $before, $sep, $after );
|
|
}
|
|
|
|
/**
|
|
* Returns the product tags.
|
|
*
|
|
* @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->id, 'product_tag', $before, $sep, $after );
|
|
}
|
|
|
|
/**
|
|
* Returns the product shipping class.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_shipping_class() {
|
|
|
|
if ( ! $this->shipping_class ) {
|
|
|
|
$classes = get_the_terms( $this->id, 'product_shipping_class' );
|
|
|
|
if ( $classes && ! is_wp_error( $classes ) ) {
|
|
$this->shipping_class = current( $classes )->slug;
|
|
} else {
|
|
$this->shipping_class = '';
|
|
}
|
|
|
|
}
|
|
|
|
return $this->shipping_class;
|
|
}
|
|
|
|
/**
|
|
* Returns the product shipping class ID.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_shipping_class_id() {
|
|
|
|
if ( ! $this->shipping_class_id ) {
|
|
|
|
$classes = get_the_terms( $this->id, 'product_shipping_class' );
|
|
|
|
if ( $classes && ! is_wp_error( $classes ) ) {
|
|
$this->shipping_class_id = current( $classes )->term_id;
|
|
} else {
|
|
$this->shipping_class_id = 0;
|
|
}
|
|
}
|
|
|
|
return absint( $this->shipping_class_id );
|
|
}
|
|
|
|
/**
|
|
* Get and return related products.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param int $limit (default: 5) Should be an integer greater than 0.
|
|
* @return array Array of post IDs
|
|
*/
|
|
public function get_related( $limit = 5 ) {
|
|
global $wpdb;
|
|
|
|
$transient_name = 'wc_related_' . $this->id;
|
|
$related_posts = get_transient( $transient_name );
|
|
$limit = $limit > 0 ? $limit : 5;
|
|
|
|
// 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 ) {
|
|
// Related products are found from category and tag
|
|
$tags_array = $this->get_related_terms( 'product_tag' );
|
|
$cats_array = $this->get_related_terms( 'product_cat' );
|
|
|
|
// Don't bother if none are set
|
|
if ( 1 === sizeof( $cats_array ) && 1 === sizeof( $tags_array )) {
|
|
$related_posts = array();
|
|
} else {
|
|
// Sanitize
|
|
$exclude_ids = array_map( 'absint', array_merge( array( 0, $this->id ), $this->get_upsells() ) );
|
|
|
|
// 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 );
|
|
|
|
// Get the posts
|
|
$related_posts = $wpdb->get_col( implode( ' ', $query ) );
|
|
}
|
|
|
|
set_transient( $transient_name, $related_posts, DAY_IN_SECONDS );
|
|
}
|
|
|
|
// Randomise the results
|
|
shuffle( $related_posts );
|
|
|
|
// Limit the returned results
|
|
return array_slice( $related_posts, 0, $limit );
|
|
}
|
|
|
|
/**
|
|
* Returns a single product attribute.
|
|
*
|
|
* @param mixed $attr
|
|
* @return string
|
|
*/
|
|
public function get_attribute( $attr ) {
|
|
|
|
$attributes = $this->get_attributes();
|
|
|
|
$attr = sanitize_title( $attr );
|
|
|
|
if ( isset( $attributes[ $attr ] ) || isset( $attributes[ 'pa_' . $attr ] ) ) {
|
|
|
|
$attribute = isset( $attributes[ $attr ] ) ? $attributes[ $attr ] : $attributes[ 'pa_' . $attr ];
|
|
|
|
if ( isset( $attribute['is_taxonomy'] ) && $attribute['is_taxonomy'] ) {
|
|
|
|
return implode( ', ', wc_get_product_terms( $this->id, $attribute['name'], array( 'fields' => 'names' ) ) );
|
|
|
|
} else {
|
|
|
|
return $attribute['value'];
|
|
}
|
|
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Returns product attributes.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_attributes() {
|
|
$attributes = array_filter( (array) maybe_unserialize( $this->product_attributes ) );
|
|
$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 );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product has any attributes set.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function has_attributes() {
|
|
|
|
if ( sizeof( $this->get_attributes() ) > 0 ) {
|
|
|
|
foreach ( $this->get_attributes() as $attribute ) {
|
|
|
|
if ( isset( $attribute['is_visible'] ) && $attribute['is_visible'] ) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not we are showing dimensions on the product page.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function enable_dimensions_display() {
|
|
return apply_filters( 'wc_product_enable_dimensions_display', true ) && ( $this->has_dimensions() || $this->has_weight() );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product has dimensions set.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function has_dimensions() {
|
|
return $this->get_dimensions() ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Does a child have dimensions set?
|
|
* @since 2.7.0
|
|
* @return boolean
|
|
*/
|
|
public function child_has_dimensions() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the product length.
|
|
* @return string
|
|
*/
|
|
public function get_length() {
|
|
return apply_filters( 'woocommerce_product_length', $this->length ? $this->length : '', $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the product width.
|
|
* @return string
|
|
*/
|
|
public function get_width() {
|
|
return apply_filters( 'woocommerce_product_width', $this->width ? $this->width : '', $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the product height.
|
|
* @return string
|
|
*/
|
|
public function get_height() {
|
|
return apply_filters( 'woocommerce_product_height', $this->height ? $this->height : '', $this );
|
|
}
|
|
|
|
/**
|
|
* Returns the product's weight.
|
|
* @todo refactor filters in this class to naming woocommerce_product_METHOD
|
|
* @return string
|
|
*/
|
|
public function get_weight() {
|
|
return apply_filters( 'woocommerce_product_weight', apply_filters( 'woocommerce_product_get_weight', $this->weight ? $this->weight : '' ), $this );
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the product has weight set.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function has_weight() {
|
|
return $this->get_weight() ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Does a child have a weight set?
|
|
* @since 2.7.0
|
|
* @return boolean
|
|
*/
|
|
public function child_has_weight() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns formatted dimensions.
|
|
* @return string
|
|
*/
|
|
public function get_dimensions() {
|
|
$dimensions = implode( ' x ', array_filter( array(
|
|
wc_format_localized_decimal( $this->get_length() ),
|
|
wc_format_localized_decimal( $this->get_width() ),
|
|
wc_format_localized_decimal( $this->get_height() ),
|
|
) ) );
|
|
|
|
if ( ! empty( $dimensions ) ) {
|
|
$dimensions .= ' ' . get_option( 'woocommerce_dimension_unit' );
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_product_dimensions', $dimensions, $this );
|
|
}
|
|
|
|
/**
|
|
* Lists a table of attributes for the product page.
|
|
*/
|
|
public function list_attributes() {
|
|
wc_get_template( 'single-product/product-attributes.php', array(
|
|
'product' => $this
|
|
) );
|
|
}
|
|
|
|
/**
|
|
* Gets the main product image ID.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_image_id() {
|
|
|
|
if ( has_post_thumbnail( $this->id ) ) {
|
|
$image_id = get_post_thumbnail_id( $this->id );
|
|
} elseif ( ( $parent_id = wp_get_post_parent_id( $this->id ) ) && has_post_thumbnail( $parent_id ) ) {
|
|
$image_id = get_post_thumbnail_id( $parent_id );
|
|
} else {
|
|
$image_id = 0;
|
|
}
|
|
|
|
return $image_id;
|
|
}
|
|
|
|
/**
|
|
* Returns the main product image.
|
|
*
|
|
* @param string $size (default: 'shop_thumbnail')
|
|
* @param array $attr
|
|
* @param bool True to return $placeholder if no image is found, or false to return an empty string.
|
|
* @return string
|
|
*/
|
|
public function get_image( $size = 'shop_thumbnail', $attr = array(), $placeholder = true ) {
|
|
if ( has_post_thumbnail( $this->id ) ) {
|
|
$image = get_the_post_thumbnail( $this->id, $size, $attr );
|
|
} elseif ( ( $parent_id = wp_get_post_parent_id( $this->id ) ) && has_post_thumbnail( $parent_id ) ) {
|
|
$image = get_the_post_thumbnail( $parent_id, $size, $attr );
|
|
} elseif ( $placeholder ) {
|
|
$image = wc_placeholder_img( $size );
|
|
} else {
|
|
$image = '';
|
|
}
|
|
|
|
return $image;
|
|
}
|
|
|
|
/**
|
|
* Get product name with SKU or ID. Used within admin.
|
|
*
|
|
* @return string Formatted product name
|
|
*/
|
|
public function get_formatted_name() {
|
|
if ( $this->get_sku() ) {
|
|
$identifier = $this->get_sku();
|
|
} else {
|
|
$identifier = '#' . $this->id;
|
|
}
|
|
|
|
return sprintf( '%s – %s', $identifier, $this->get_title() );
|
|
}
|
|
|
|
/**
|
|
* Retrieves related product terms.
|
|
*
|
|
* @param string $term
|
|
* @return array
|
|
*/
|
|
protected function get_related_terms( $term ) {
|
|
$terms_array = array(0);
|
|
|
|
$terms = apply_filters( 'woocommerce_get_related_' . $term . '_terms', wp_get_post_terms( $this->id, $term ), $this->id );
|
|
foreach ( $terms as $term ) {
|
|
$terms_array[] = $term->term_id;
|
|
}
|
|
|
|
return array_map( 'absint', $terms_array );
|
|
}
|
|
|
|
/**
|
|
* Builds the related posts query.
|
|
*
|
|
* @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'";
|
|
}
|
|
|
|
$relate_by_category = apply_filters( 'woocommerce_product_related_posts_relate_by_category', true, $this->id );
|
|
$relate_by_tag = apply_filters( 'woocommerce_product_related_posts_relate_by_tag', true, $this->id );
|
|
|
|
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 ) . " ) ) ";
|
|
if ( $relate_by_tag ) {
|
|
$query['where'] .= ' OR ';
|
|
}
|
|
}
|
|
|
|
if ( $relate_by_tag ) {
|
|
$query['where'] .= " ( tt.taxonomy = 'product_tag' AND t.term_id IN ( " . implode( ',', $tags_array ) . " ) ) ";
|
|
}
|
|
|
|
$query['where'] .= ')';
|
|
}
|
|
|
|
$query['limits'] = " LIMIT {$limit} ";
|
|
$query = apply_filters( 'woocommerce_product_related_posts_query', $query, $this->id );
|
|
|
|
return $query;
|
|
}
|
|
}
|