wc-stock-functions.php — WooCommerce 3.0.3

woocommerce / includes / wc-stock-functions.php

woocommerce / includes Last commit date

wc-stock-functions.php

115 lines

1	<?php
2	/**
3	* WooCommerce Stock Functions
4	*
5	* Functions used to manage product stock levels.
6	*
7	* @author WooThemes
8	* @category Core
9	* @package WooCommerce/Functions
10	*/
11
12	if ( ! defined( 'ABSPATH' ) ) {
13	exit;
14	}
15
16	/**
17	* Update a product's stock amount.
18	*
19	* Uses queries rather than update_post_meta so we can do this in one query (to avoid stock issues).
20	*
21	* @since 3.0.0 this supports set, increase and decrease.
22	* @param int\|WC_Product $product
23	* @param int\|null $stock_quantity
24	* @param string $operation set, increase and decrease.
25	*/
26	function wc_update_product_stock( $product, $stock_quantity = null, $operation = 'set' ) {
27	if ( ! $product = wc_get_product( $product ) ) {
28	return false;
29	}
30	if ( ! is_null( $stock_quantity ) && $product->managing_stock() ) {
31	// Some products (variations) can have their stock managed by their parent. Get the correct ID to reduce here.
32	$product_id_with_stock = $product->get_stock_managed_by_id();
33	$data_store = WC_Data_Store::load( 'product' );
34	$data_store->update_product_stock( $product_id_with_stock, $stock_quantity, $operation );
35	delete_transient( 'wc_low_stock_count' );
36	delete_transient( 'wc_outofstock_count' );
37	delete_transient( 'wc_product_children_' . ( $product->is_type( 'variation' ) ? $product->get_parent_id() : $product->get_id() ) );
38	wp_cache_delete( 'product-' . $product_id_with_stock, 'products' );
39
40	// Re-read product data after updating stock, then have stock status calculated and saved.
41	$product_with_stock = wc_get_product( $product_id_with_stock );
42	$product_with_stock->set_stock_status();
43	$product_with_stock->save();
44
45	do_action( $product_with_stock->is_type( 'variation' ) ? 'woocommerce_variation_set_stock' : 'woocommerce_product_set_stock', $product_with_stock );
46
47	return $product_with_stock->get_stock_quantity();
48	}
49	return $product->get_stock_quantity();
50	}
51
52	/**
53	* Update a product's stock status.
54	*
55	* @param int $product_id
56	* @param int $status
57	*/
58	function wc_update_product_stock_status( $product_id, $status ) {
59	$product = wc_get_product( $product_id );
60	if ( $product ) {
61	$product->set_stock_status( $status );
62	$product->save();
63	}
64	}
65
66	/**
67	* When a payment is complete, we can reduce stock levels for items within an order.
68	* @since 3.0.0
69	* @param int $order_id
70	*/
71	function wc_maybe_reduce_stock_levels( $order_id ) {
72	$data_store = WC_Data_Store::load( 'order' );
73	if ( apply_filters( 'woocommerce_payment_complete_reduce_order_stock', ! $data_store->get_stock_reduced( $order_id ), $order_id ) ) {
74	wc_reduce_stock_levels( $order_id );
75	$data_store->set_stock_reduced( $order_id, true );
76	}
77	}
78	add_action( 'woocommerce_payment_complete', 'wc_maybe_reduce_stock_levels' );
79
80	/**
81	* Reduce stock levels for items within an order.
82	* @since 3.0.0
83	* @param int $order_id
84	*/
85	function wc_reduce_stock_levels( $order_id ) {
86	$order = wc_get_order( $order_id );
87
88	if ( 'yes' === get_option( 'woocommerce_manage_stock' ) && $order && apply_filters( 'woocommerce_can_reduce_order_stock', true, $order ) && sizeof( $order->get_items() ) > 0 ) {
89	foreach ( $order->get_items() as $item ) {
90	if ( $item->is_type( 'line_item' ) && ( $product = $item->get_product() ) && $product->managing_stock() ) {
91	$qty = apply_filters( 'woocommerce_order_item_quantity', $item->get_quantity(), $order, $item );
92	$item_name = $product->get_formatted_name();
93	$new_stock = wc_update_product_stock( $product, $qty, 'decrease' );
94
95	if ( ! is_wp_error( $new_stock ) ) {
96	/* translators: 1: item name 2: old stock quantity 3: new stock quantity */
97	$order->add_order_note( sprintf( __( '%1$s stock reduced from %2$s to %3$s.', 'woocommerce' ), $item_name, $new_stock + $qty, $new_stock ) );
98
99	if ( '' !== get_option( 'woocommerce_notify_no_stock_amount' ) && $new_stock <= get_option( 'woocommerce_notify_no_stock_amount' ) ) {
100	do_action( 'woocommerce_no_stock', $product );
101	} elseif ( '' !== get_option( 'woocommerce_notify_low_stock_amount' ) && $new_stock <= get_option( 'woocommerce_notify_low_stock_amount' ) ) {
102	do_action( 'woocommerce_low_stock', $product );
103	}
104
105	if ( $new_stock < 0 ) {
106	do_action( 'woocommerce_product_on_backorder', array( 'product' => $product, 'order_id' => $order_id, 'quantity' => $qty ) );
107	}
108	}
109	}
110	}
111
112	do_action( 'woocommerce_reduce_order_stock', $order );
113	}
114	}
115