wc-order-item-functions.php — WooCommerce 4.8.0

woocommerce / includes / wc-order-item-functions.php

woocommerce / includes Last commit date

wc-order-item-functions.php

182 lines

1	<?php
2	/**
3	* WooCommerce Order Item Functions
4	*
5	* Functions for order specific things.
6	*
7	* @package WooCommerce\Functions
8	* @version 3.4.0
9	*/
10
11	defined( 'ABSPATH' ) \|\| exit;
12
13	/**
14	* Add a item to an order (for example a line item).
15	*
16	* @param int $order_id Order ID.
17	* @param array $item_array Items list.
18	*
19	* @throws Exception When `WC_Data_Store::load` validation fails.
20	* @return int\|bool Item ID or false
21	*/
22	function wc_add_order_item( $order_id, $item_array ) {
23	$order_id = absint( $order_id );
24
25	if ( ! $order_id ) {
26	return false;
27	}
28
29	$defaults = array(
30	'order_item_name' => '',
31	'order_item_type' => 'line_item',
32	);
33
34	$item_array = wp_parse_args( $item_array, $defaults );
35	$data_store = WC_Data_Store::load( 'order-item' );
36	$item_id = $data_store->add_order_item( $order_id, $item_array );
37	$item = WC_Order_Factory::get_order_item( $item_id );
38
39	do_action( 'woocommerce_new_order_item', $item_id, $item, $order_id );
40
41	return $item_id;
42	}
43
44	/**
45	* Update an item for an order.
46	*
47	* @since 2.2
48	* @param int $item_id Item ID.
49	* @param array $args Either `order_item_type` or `order_item_name`.
50	*
51	* @throws Exception When `WC_Data_Store::load` validation fails.
52	* @return bool True if successfully updated, false otherwise.
53	*/
54	function wc_update_order_item( $item_id, $args ) {
55	$data_store = WC_Data_Store::load( 'order-item' );
56	$update = $data_store->update_order_item( $item_id, $args );
57
58	if ( false === $update ) {
59	return false;
60	}
61
62	do_action( 'woocommerce_update_order_item', $item_id, $args );
63
64	return true;
65	}
66
67	/**
68	* Delete an item from the order it belongs to based on item id.
69	*
70	* @param int $item_id Item ID.
71	*
72	* @throws Exception When `WC_Data_Store::load` validation fails.
73	* @return bool
74	*/
75	function wc_delete_order_item( $item_id ) {
76	$item_id = absint( $item_id );
77
78	if ( ! $item_id ) {
79	return false;
80	}
81
82	$data_store = WC_Data_Store::load( 'order-item' );
83
84	do_action( 'woocommerce_before_delete_order_item', $item_id );
85
86	$data_store->delete_order_item( $item_id );
87
88	do_action( 'woocommerce_delete_order_item', $item_id );
89
90	return true;
91	}
92
93	/**
94	* WooCommerce Order Item Meta API - Update term meta.
95	*
96	* @param int $item_id Item ID.
97	* @param string $meta_key Meta key.
98	* @param string $meta_value Meta value.
99	* @param string $prev_value Previous value (default: '').
100	*
101	* @throws Exception When `WC_Data_Store::load` validation fails.
102	* @return bool
103	*/
104	function wc_update_order_item_meta( $item_id, $meta_key, $meta_value, $prev_value = '' ) {
105	$data_store = WC_Data_Store::load( 'order-item' );
106	if ( $data_store->update_metadata( $item_id, $meta_key, $meta_value, $prev_value ) ) {
107	WC_Cache_Helper::invalidate_cache_group( 'object_' . $item_id ); // Invalidate cache.
108	return true;
109	}
110	return false;
111	}
112
113	/**
114	* WooCommerce Order Item Meta API - Add term meta.
115	*
116	* @param int $item_id Item ID.
117	* @param string $meta_key Meta key.
118	* @param string $meta_value Meta value.
119	* @param bool $unique If meta data should be unique (default: false).
120	*
121	* @throws Exception When `WC_Data_Store::load` validation fails.
122	* @return int New row ID or 0.
123	*/
124	function wc_add_order_item_meta( $item_id, $meta_key, $meta_value, $unique = false ) {
125	$data_store = WC_Data_Store::load( 'order-item' );
126	$meta_id = $data_store->add_metadata( $item_id, $meta_key, $meta_value, $unique );
127
128	if ( $meta_id ) {
129	WC_Cache_Helper::invalidate_cache_group( 'object_' . $item_id ); // Invalidate cache.
130	return $meta_id;
131	}
132	return 0;
133	}
134
135	/**
136	* WooCommerce Order Item Meta API - Delete term meta.
137	*
138	* @param int $item_id Item ID.
139	* @param string $meta_key Meta key.
140	* @param string $meta_value Meta value (default: '').
141	* @param bool $delete_all Delete all meta data, defaults to `false`.
142	*
143	* @throws Exception When `WC_Data_Store::load` validation fails.
144	* @return bool
145	*/
146	function wc_delete_order_item_meta( $item_id, $meta_key, $meta_value = '', $delete_all = false ) {
147	$data_store = WC_Data_Store::load( 'order-item' );
148	if ( $data_store->delete_metadata( $item_id, $meta_key, $meta_value, $delete_all ) ) {
149	WC_Cache_Helper::invalidate_cache_group( 'object_' . $item_id ); // Invalidate cache.
150	return true;
151	}
152	return false;
153	}
154
155	/**
156	* WooCommerce Order Item Meta API - Get term meta.
157	*
158	* @param int $item_id Item ID.
159	* @param string $key Meta key.
160	* @param bool $single Whether to return a single value. (default: true).
161	*
162	* @throws Exception When `WC_Data_Store::load` validation fails.
163	* @return mixed
164	*/
165	function wc_get_order_item_meta( $item_id, $key, $single = true ) {
166	$data_store = WC_Data_Store::load( 'order-item' );
167	return $data_store->get_metadata( $item_id, $key, $single );
168	}
169
170	/**
171	* Get order ID by order item ID.
172	*
173	* @param int $item_id Item ID.
174	*
175	* @throws Exception When `WC_Data_Store::load` validation fails.
176	* @return int
177	*/
178	function wc_get_order_id_by_order_item_id( $item_id ) {
179	$data_store = WC_Data_Store::load( 'order-item' );
180	return $data_store->get_order_id_by_order_item_id( $item_id );
181	}
182