Check if a product is on backorder.
| public is_on_backorder ( integer $qty_in_cart ) : boolean | ||
| $qty_in_cart | integer | (default: 0) |
| return | boolean | |
/**
* Get standard product data that applies to every product type
*
* @since 2.1
* @param WC_Product $product
* @return array
*/
private function get_product_data($product)
{
return array('title' => $product->get_name(), 'id' => $product->get_id(), 'created_at' => $this->server->format_datetime($product->get_date_created(), false, true), 'updated_at' => $this->server->format_datetime($product->get_date_modified(), false, true), 'type' => $product->get_type(), 'status' => $product->get_status(), 'downloadable' => $product->is_downloadable(), 'virtual' => $product->is_virtual(), 'permalink' => $product->get_permalink(), 'sku' => $product->get_sku(), 'price' => wc_format_decimal($product->get_price(), 2), 'regular_price' => wc_format_decimal($product->get_regular_price(), 2), 'sale_price' => $product->get_sale_price() ? wc_format_decimal($product->get_sale_price(), 2) : null, 'price_html' => $product->get_price_html(), 'taxable' => $product->is_taxable(), 'tax_status' => $product->get_tax_status(), 'tax_class' => $product->get_tax_class(), 'managing_stock' => $product->managing_stock(), 'stock_quantity' => $product->get_stock_quantity(), 'in_stock' => $product->is_in_stock(), 'backorders_allowed' => $product->backorders_allowed(), 'backordered' => $product->is_on_backorder(), 'sold_individually' => $product->is_sold_individually(), 'purchaseable' => $product->is_purchasable(), 'featured' => $product->is_featured(), 'visible' => $product->is_visible(), 'catalog_visibility' => $product->get_catalog_visibility(), 'on_sale' => $product->is_on_sale(), 'weight' => $product->get_weight() ? wc_format_decimal($product->get_weight(), 2) : null, 'dimensions' => array('length' => $product->get_length(), 'width' => $product->get_width(), 'height' => $product->get_height(), 'unit' => get_option('woocommerce_dimension_unit')), 'shipping_required' => $product->needs_shipping(), 'shipping_taxable' => $product->is_shipping_taxable(), 'shipping_class' => $product->get_shipping_class(), 'shipping_class_id' => 0 !== $product->get_shipping_class_id() ? $product->get_shipping_class_id() : null, 'description' => apply_filters('the_content', $product->get_description()), 'short_description' => apply_filters('woocommerce_short_description', $product->get_short_description()), 'reviews_allowed' => $product->get_reviews_allowed(), 'average_rating' => wc_format_decimal($product->get_average_rating(), 2), 'rating_count' => $product->get_rating_count(), 'related_ids' => array_map('absint', array_values(wc_get_related_products($product->get_id()))), 'upsell_ids' => array_map('absint', $product->get_upsell_ids()), 'cross_sell_ids' => array_map('absint', $product->get_cross_sell_ids()), 'categories' => wc_get_object_terms($product->get_id(), 'product_cat', 'name'), 'tags' => wc_get_object_terms($product->get_id(), 'product_tag', 'name'), 'images' => $this->get_images($product), 'featured_src' => wp_get_attachment_url(get_post_thumbnail_id($product->get_id())), 'attributes' => $this->get_attributes($product), 'downloads' => $this->get_downloads($product), 'download_limit' => $product->get_download_limit(), 'download_expiry' => $product->get_download_expiry(), 'download_type' => 'standard', 'purchase_note' => apply_filters('the_content', $product->get_purchase_note()), 'total_sales' => $product->get_total_sales(), 'variations' => array(), 'parent' => array());
}
/**
* Add a product line item to the order
*
* @since 2.2
* @param \WC_Product $product
* @param int $qty Line item quantity
* @param array $args
* @return int|bool Item ID or false
*/
public function add_product($product, $qty = 1, $args = array())
{
$default_args = array('variation' => array(), 'totals' => array());
$args = wp_parse_args($args, $default_args);
$item_id = wc_add_order_item($this->id, array('order_item_name' => $product->get_title(), 'order_item_type' => 'line_item'));
if (!$item_id) {
return false;
}
wc_add_order_item_meta($item_id, '_qty', wc_stock_amount($qty));
wc_add_order_item_meta($item_id, '_tax_class', $product->get_tax_class());
wc_add_order_item_meta($item_id, '_product_id', $product->id);
wc_add_order_item_meta($item_id, '_variation_id', isset($product->variation_id) ? $product->variation_id : 0);
// Set line item totals, either passed in or from the product
wc_add_order_item_meta($item_id, '_line_subtotal', wc_format_decimal(isset($args['totals']['subtotal']) ? $args['totals']['subtotal'] : $product->get_price_excluding_tax($qty)));
wc_add_order_item_meta($item_id, '_line_total', wc_format_decimal(isset($args['totals']['total']) ? $args['totals']['total'] : $product->get_price_excluding_tax($qty)));
wc_add_order_item_meta($item_id, '_line_subtotal_tax', wc_format_decimal(isset($args['totals']['subtotal_tax']) ? $args['totals']['subtotal_tax'] : 0));
wc_add_order_item_meta($item_id, '_line_tax', wc_format_decimal(isset($args['totals']['tax']) ? $args['totals']['tax'] : 0));
// Save tax data - Since 2.2
if (isset($args['totals']['tax_data'])) {
$tax_data = array();
$tax_data['total'] = array_map('wc_format_decimal', $args['totals']['tax_data']['total']);
$tax_data['subtotal'] = array_map('wc_format_decimal', $args['totals']['tax_data']['subtotal']);
wc_add_order_item_meta($item_id, '_line_tax_data', $tax_data);
} else {
wc_add_order_item_meta($item_id, '_line_tax_data', array('total' => array(), 'subtotal' => array()));
}
// Add variation meta
if (!empty($args['variation'])) {
foreach ($args['variation'] as $key => $value) {
wc_add_order_item_meta($item_id, str_replace('attribute_', '', $key), $value);
}
}
// Backorders
if ($product->backorders_require_notification() && $product->is_on_backorder($qty)) {
wc_add_order_item_meta($item_id, apply_filters('woocommerce_backordered_item_meta_name', __('Backordered', 'woocommerce')), $qty - max(0, $product->get_total_stock()));
}
do_action('woocommerce_order_add_product', $this->id, $item_id, $product, $qty, $args);
return $item_id;
}
/**
* Get standard product data that applies to every product type
*
* @since 2.1
* @param WC_Product $product
* @return WC_Product
*/
private function get_product_data($product)
{
return array('title' => $product->get_title(), 'id' => (int) $product->is_type('variation') ? $product->get_variation_id() : $product->id, 'created_at' => $this->server->format_datetime($product->get_post_data()->post_date_gmt), 'updated_at' => $this->server->format_datetime($product->get_post_data()->post_modified_gmt), 'type' => $product->product_type, 'status' => $product->get_post_data()->post_status, 'downloadable' => $product->is_downloadable(), 'virtual' => $product->is_virtual(), 'permalink' => $product->get_permalink(), 'sku' => $product->get_sku(), 'price' => $product->get_price(), 'regular_price' => $product->get_regular_price(), 'sale_price' => $product->get_sale_price() ? $product->get_sale_price() : null, 'price_html' => $product->get_price_html(), 'taxable' => $product->is_taxable(), 'tax_status' => $product->get_tax_status(), 'tax_class' => $product->get_tax_class(), 'managing_stock' => $product->managing_stock(), 'stock_quantity' => $product->get_stock_quantity(), 'in_stock' => $product->is_in_stock(), 'backorders_allowed' => $product->backorders_allowed(), 'backordered' => $product->is_on_backorder(), 'sold_individually' => $product->is_sold_individually(), 'purchaseable' => $product->is_purchasable(), 'featured' => $product->is_featured(), 'visible' => $product->is_visible(), 'catalog_visibility' => $product->visibility, 'on_sale' => $product->is_on_sale(), 'product_url' => $product->is_type('external') ? $product->get_product_url() : '', 'button_text' => $product->is_type('external') ? $product->get_button_text() : '', 'weight' => $product->get_weight() ? $product->get_weight() : null, 'dimensions' => array('length' => $product->length, 'width' => $product->width, 'height' => $product->height, 'unit' => get_option('woocommerce_dimension_unit')), 'shipping_required' => $product->needs_shipping(), 'shipping_taxable' => $product->is_shipping_taxable(), 'shipping_class' => $product->get_shipping_class(), 'shipping_class_id' => 0 !== $product->get_shipping_class_id() ? $product->get_shipping_class_id() : null, 'description' => wpautop(do_shortcode($product->get_post_data()->post_content)), 'short_description' => apply_filters('woocommerce_short_description', $product->get_post_data()->post_excerpt), 'reviews_allowed' => 'open' === $product->get_post_data()->comment_status, 'average_rating' => wc_format_decimal($product->get_average_rating(), 2), 'rating_count' => (int) $product->get_rating_count(), 'related_ids' => array_map('absint', array_values($product->get_related())), 'upsell_ids' => array_map('absint', $product->get_upsells()), 'cross_sell_ids' => array_map('absint', $product->get_cross_sells()), 'parent_id' => $product->post->post_parent, 'categories' => wp_get_post_terms($product->id, 'product_cat', array('fields' => 'names')), 'tags' => wp_get_post_terms($product->id, 'product_tag', array('fields' => 'names')), 'images' => $this->get_images($product), 'featured_src' => (string) wp_get_attachment_url(get_post_thumbnail_id($product->is_type('variation') ? $product->variation_id : $product->id)), 'attributes' => $this->get_attributes($product), 'downloads' => $this->get_downloads($product), 'download_limit' => (int) $product->download_limit, 'download_expiry' => (int) $product->download_expiry, 'download_type' => $product->download_type, 'purchase_note' => wpautop(do_shortcode(wp_kses_post($product->purchase_note))), 'total_sales' => metadata_exists('post', $product->id, 'total_sales') ? (int) get_post_meta($product->id, 'total_sales', true) : 0, 'variations' => array(), 'parent' => array(), 'grouped_products' => array());
}
/**
* is_on_backorder function.
*
* @param int $qty_in_cart (default: 0)
* @return bool
*/
public function is_on_backorder($qty_in_cart = 0)
{
if (true === $this->managing_stock()) {
return parent::is_on_backorder($qty_in_cart);
} else {
return $this->parent->is_on_backorder($qty_in_cart);
}
}
/**
* Is on backorder?
*
* @param int $qty_in_cart (default: 0)
* @return bool
*/
public function is_on_backorder($qty_in_cart = 0)
{
if (true === $this->managing_stock()) {
return parent::is_on_backorder($qty_in_cart);
} else {
return $this->parent->managing_stock() && $this->parent->backorders_allowed() && $this->parent->get_stock_quantity() - $qty_in_cart < 0;
}
}
/**
* Get standard product data that applies to every product type
*
* @since 2.1
* @param WC_Product $product
* @return WC_Product
*/
private function get_product_data($product, $fields = null)
{
if ($fields) {
$field_list = explode(',', $fields);
}
$product_data = array();
if (!$fields || $fields && in_array('title', $field_list)) {
$product_data['title'] = $product->get_title();
}
if (!$fields || $fields && in_array('id', $field_list)) {
$product_data['id'] = (int) $product->is_type('variation') ? $product->get_variation_id() : $product->id;
}
if (!$fields || $fields && in_array('created_at', $field_list)) {
$product_data['created_at'] = $this->server->format_datetime($product->get_post_data()->post_date_gmt);
}
if (!$fields || $fields && in_array('updated_at', $field_list)) {
$product_data['updated_at'] = $this->server->format_datetime($product->get_post_data()->post_modified_gmt);
}
if (!$fields || $fields && in_array('type', $field_list)) {
$product_data['type'] = $product->product_type;
}
if (!$fields || $fields && in_array('status', $field_list)) {
$product_data['status'] = $product->get_post_data()->post_status;
}
if (!$fields || $fields && in_array('downloadable', $field_list)) {
$product_data['downloadable'] = $product->is_downloadable();
}
if (!$fields || $fields && in_array('virtual', $field_list)) {
$product_data['virtual'] = $product->is_virtual();
}
if (!$fields || $fields && in_array('permalink', $field_list)) {
$product_data['permalink'] = $product->get_permalink();
}
if (!$fields || $fields && in_array('sku', $field_list)) {
$product_data['sku'] = $product->get_sku();
}
if (!$fields || $fields && in_array('price', $field_list)) {
$product_data['price'] = $product->get_price();
}
if (!$fields || $fields && in_array('regular_price', $field_list)) {
$product_data['regular_price'] = $product->get_regular_price();
}
if (!$fields || $fields && in_array('sale_price', $field_list)) {
$product_data['sale_price'] = $product->get_sale_price() ? $product->get_sale_price() : null;
}
if (!$fields || $fields && in_array('price_html', $field_list)) {
$product_data['price_html'] = $product->get_price_html();
}
if (!$fields || $fields && in_array('taxable', $field_list)) {
$product_data['taxable'] = $product->is_taxable();
}
if (!$fields || $fields && in_array('tax_status', $field_list)) {
$product_data['tax_status'] = $product->get_tax_status();
}
if (!$fields || $fields && in_array('tax_class', $field_list)) {
$product_data['tax_class'] = $product->get_tax_class();
}
if (!$fields || $fields && in_array('managing_stock', $field_list)) {
$product_data['managing_stock'] = $product->managing_stock();
}
if (!$fields || $fields && in_array('stock_quantity', $field_list)) {
$product_data['stock_quantity'] = $product->get_stock_quantity();
}
if (!$fields || $fields && in_array('in_stock', $field_list)) {
$product_data['in_stock'] = $product->is_in_stock();
}
if (!$fields || $fields && in_array('backorders_allowed', $field_list)) {
$product_data['backorders_allowed'] = $product->backorders_allowed();
}
if (!$fields || $fields && in_array('backordered', $field_list)) {
$product_data['backordered'] = $product->is_on_backorder();
}
if (!$fields || $fields && in_array('sold_individually', $field_list)) {
$product_data['sold_individually'] = $product->is_sold_individually();
}
if (!$fields || $fields && in_array('purchaseable', $field_list)) {
$product_data['purchaseable'] = $product->is_purchasable();
}
if (!$fields || $fields && in_array('featured', $field_list)) {
$product_data['featured'] = $product->is_featured();
}
if (!$fields || $fields && in_array('visible', $field_list)) {
$product_data['visible'] = $product->is_visible();
}
if (!$fields || $fields && in_array('catalog_visibility', $field_list)) {
$product_data['catalog_visibility'] = $product->visibility;
}
if (!$fields || $fields && in_array('on_sale', $field_list)) {
$product_data['on_sale'] = $product->is_on_sale();
}
if (!$fields || $fields && in_array('product_url', $field_list)) {
$product_data['product_url'] = $product->is_type('external') ? $product->get_product_url() : '';
}
if (!$fields || $fields && in_array('button_text', $field_list)) {
$product_data['button_text'] = $product->is_type('external') ? $product->get_button_text() : '';
}
if (!$fields || $fields && in_array('weight', $field_list)) {
$product_data['weight'] = $product->get_weight() ? $product->get_weight() : null;
}
if (!$fields || $fields && in_array('dimensions', $field_list)) {
$product_data['dimensions'] = array('length' => $product->length, 'width' => $product->width, 'height' => $product->height, 'unit' => get_option('woocommerce_dimension_unit'));
}
if (!$fields || $fields && in_array('shipping_required', $field_list)) {
$product_data['shipping_required'] = $product->needs_shipping();
}
if (!$fields || $fields && in_array('shipping_taxable', $field_list)) {
$product_data['shipping_taxable'] = $product->is_shipping_taxable();
}
if (!$fields || $fields && in_array('shipping_class', $field_list)) {
$product_data['shipping_class'] = $product->get_shipping_class();
}
if (!$fields || $fields && in_array('shipping_class_id', $field_list)) {
$product_data['shipping_class_id'] = 0 !== $product->get_shipping_class_id() ? $product->get_shipping_class_id() : null;
}
if (!$fields || $fields && in_array('description', $field_list)) {
$product_data['description'] = wpautop(do_shortcode($product->get_post_data()->post_content));
}
if (!$fields || $fields && in_array('short_description', $field_list)) {
$product_data['short_description'] = apply_filters('woocommerce_short_description', $product->get_post_data()->post_excerpt);
}
if (!$fields || $fields && in_array('reviews_allowed', $field_list)) {
$product_data['reviews_allowed'] = 'open' === $product->get_post_data()->comment_status;
}
if (!$fields || $fields && in_array('average_rating', $field_list)) {
$product_data['average_rating'] = wc_format_decimal($product->get_average_rating(), 2);
}
if (!$fields || $fields && in_array('rating_count', $field_list)) {
$product_data['rating_count'] = (int) $product->get_rating_count();
}
if (!$fields || $fields && in_array('related_ids', $field_list)) {
$product_data['related_ids'] = array_map('absint', array_values($product->get_related()));
}
if (!$fields || $fields && in_array('upsell_ids', $field_list)) {
$product_data['upsell_ids'] = array_map('absint', $product->get_upsells());
}
if (!$fields || $fields && in_array('cross_sell_ids', $field_list)) {
$product_data['cross_sell_ids'] = array_map('absint', $product->get_cross_sells());
}
if (!$fields || $fields && in_array('parent_id', $field_list)) {
$product_data['parent_id'] = $product->post->post_parent;
}
if (!$fields || $fields && in_array('categories', $field_list)) {
$product_data['categories'] = wp_get_post_terms($product->id, 'product_cat', array('fields' => 'names'));
}
if (!$fields || $fields && in_array('tags', $field_list)) {
$product_data['tags'] = wp_get_post_terms($product->id, 'product_tag', array('fields' => 'names'));
}
if (!$fields || $fields && in_array('images', $field_list)) {
$product_data['images'] = $this->get_images($product);
}
if (!$fields || $fields && in_array('featured_src', $field_list)) {
$product_data['featured_src'] = (string) wp_get_attachment_url(get_post_thumbnail_id($product->is_type('variation') ? $product->variation_id : $product->id));
}
if (!$fields || $fields && in_array('attributes', $field_list)) {
$product_data['attributes'] = $this->get_attributes($product);
}
if (!$fields || $fields && in_array('downloads', $field_list)) {
$product_data['downloads'] = $this->get_downloads($product);
}
if (!$fields || $fields && in_array('download_limit', $field_list)) {
$product_data['download_limit'] = (int) $product->download_limit;
}
if (!$fields || $fields && in_array('download_expiry', $field_list)) {
$product_data['download_expiry'] = (int) $product->download_expiry;
}
if (!$fields || $fields && in_array('download_type', $field_list)) {
$product_data['download_type'] = $product->download_type;
}
if (!$fields || $fields && in_array('purchase_note', $field_list)) {
$product_data['purchase_note'] = wpautop(do_shortcode(wp_kses_post($product->purchase_note)));
}
if (!$fields || $fields && in_array('total_sales', $field_list)) {
$product_data['total_sales'] = metadata_exists('post', $product->id, 'total_sales') ? (int) get_post_meta($product->id, 'total_sales', true) : 0;
}
if (!$fields || $fields && in_array('variations', $field_list)) {
$product_data['variations'] = array();
}
if (!$fields || $fields && in_array('parent', $field_list)) {
$product_data['parent'] = array();
}
if (!$fields || $fields && in_array('grouped_products', $field_list)) {
$product_data['grouped_products'] = array();
}
if (!$fields || $fields && in_array('menu_order', $field_list)) {
$product_data['menu_order'] = $product->post->menu_order;
}
return $product_data;
}
/**
* A bundle appears "on backorder" if the container is on backorder, or if a bundled item is on backorder (and requires notification).
*
* @return boolean true if on backorder
*/
public function is_on_backorder($qty_in_cart = 0)
{
if (!$this->is_synced()) {
$this->sync_bundle();
}
return parent::is_on_backorder() || $this->has_items_on_backorder;
}
/**
* Update a line item for the order.
*
* Note this does not update order totals.
*
* @param object|int $item order item ID or item object.
* @param WC_Product $product
* @param array $args data to update.
* @return int updated order item ID
*/
public function update_product($item, $product, $args)
{
_deprecated_function('WC_Order::update_product', '2.7', 'Interact with WC_Order_Item_Product class');
if (is_numeric($item)) {
$item = $this->get_item($item);
}
if (!is_object($item) || !$item->is_type('line_item')) {
return false;
}
if (!$this->get_id()) {
$this->save();
// Order must exist
}
// BW compatibility with old args
if (isset($args['totals'])) {
foreach ($args['totals'] as $key => $value) {
if ('tax' === $key) {
$args['total_tax'] = $value;
} elseif ('tax_data' === $key) {
$args['taxes'] = $value;
} else {
$args[$key] = $value;
}
}
}
// Handly qty if set
if (isset($args['qty'])) {
if ($product->backorders_require_notification() && $product->is_on_backorder($args['qty'])) {
$item->add_meta_data(apply_filters('woocommerce_backordered_item_meta_name', __('Backordered', 'woocommerce')), $args['qty'] - max(0, $product->get_total_stock()), true);
}
$args['subtotal'] = $args['subtotal'] ? $args['subtotal'] : $product->get_price_excluding_tax($args['qty']);
$args['total'] = $args['total'] ? $args['total'] : $product->get_price_excluding_tax($args['qty']);
}
$item->set_order_id($this->get_id());
$item->set_all($args);
$item->save();
do_action('woocommerce_order_edit_product', $this->get_id(), $item->get_id(), $args, $product);
return $item->get_id();
}
