class-wc-cart-session.php — WooCommerce 7.6.1

woocommerce / includes / class-wc-cart-session.php

woocommerce / includes Last commit date

class-wc-cart-session.php

468 lines

1	<?php
2	/**
3	* Cart session handling class.
4	*
5	* @package WooCommerce\Classes
6	* @version 3.2.0
7	*/
8
9	if ( ! defined( 'ABSPATH' ) ) {
10	exit;
11	}
12
13	/**
14	* WC_Cart_Session class.
15	*
16	* @since 3.2.0
17	*/
18	final class WC_Cart_Session {
19
20	/**
21	* Reference to cart object.
22	*
23	* @since 3.2.0
24	* @var WC_Cart
25	*/
26	protected $cart;
27
28	/**
29	* Sets up the items provided, and calculate totals.
30	*
31	* @since 3.2.0
32	* @throws Exception If missing WC_Cart object.
33	*
34	* @param WC_Cart $cart Cart object to calculate totals for.
35	*/
36	public function __construct( &$cart ) {
37	if ( ! is_a( $cart, 'WC_Cart' ) ) {
38	throw new Exception( 'A valid WC_Cart object is required' );
39	}
40
41	$this->cart = $cart;
42	}
43
44	/**
45	* Register methods for this object on the appropriate WordPress hooks.
46	*/
47	public function init() {
48	/**
49	* Filters whether hooks should be initialized for the current cart session.
50	*
51	* @param bool $must_initialize Will be passed as true, meaning that the cart hooks should be initialized.
52	* @param bool $session The WC_Cart_Session object that is being initialized.
53	* @returns bool True if the cart hooks should be actually initialized, false if not.
54	*
55	* @since 6.9.0
56	*/
57	if ( ! apply_filters( 'woocommerce_cart_session_initialize', true, $this ) ) {
58	return;
59	}
60
61	add_action( 'wp_loaded', array( $this, 'get_cart_from_session' ) );
62	add_action( 'woocommerce_cart_emptied', array( $this, 'destroy_cart_session' ) );
63	add_action( 'woocommerce_after_calculate_totals', array( $this, 'set_session' ), 1000 );
64	add_action( 'woocommerce_cart_loaded_from_session', array( $this, 'set_session' ) );
65	add_action( 'woocommerce_removed_coupon', array( $this, 'set_session' ) );
66
67	// Persistent cart stored to usermeta.
68	add_action( 'woocommerce_add_to_cart', array( $this, 'persistent_cart_update' ) );
69	add_action( 'woocommerce_cart_item_removed', array( $this, 'persistent_cart_update' ) );
70	add_action( 'woocommerce_cart_item_restored', array( $this, 'persistent_cart_update' ) );
71	add_action( 'woocommerce_cart_item_set_quantity', array( $this, 'persistent_cart_update' ) );
72
73	// Cookie events - cart cookies need to be set before headers are sent.
74	add_action( 'woocommerce_add_to_cart', array( $this, 'maybe_set_cart_cookies' ) );
75	add_action( 'wp', array( $this, 'maybe_set_cart_cookies' ), 99 );
76	add_action( 'shutdown', array( $this, 'maybe_set_cart_cookies' ), 0 );
77	}
78
79	/**
80	* Get the cart data from the PHP session and store it in class variables.
81	*
82	* @since 3.2.0
83	*/
84	public function get_cart_from_session() {
85	do_action( 'woocommerce_load_cart_from_session' );
86	$this->cart->set_totals( WC()->session->get( 'cart_totals', null ) );
87	$this->cart->set_applied_coupons( WC()->session->get( 'applied_coupons', array() ) );
88	$this->cart->set_coupon_discount_totals( WC()->session->get( 'coupon_discount_totals', array() ) );
89	$this->cart->set_coupon_discount_tax_totals( WC()->session->get( 'coupon_discount_tax_totals', array() ) );
90	$this->cart->set_removed_cart_contents( WC()->session->get( 'removed_cart_contents', array() ) );
91
92	$update_cart_session = false; // Flag to indicate the stored cart should be updated.
93	$order_again = false; // Flag to indicate whether this is a re-order.
94	$cart = WC()->session->get( 'cart', null );
95	$merge_saved_cart = (bool) get_user_meta( get_current_user_id(), '_woocommerce_load_saved_cart_after_login', true );
96
97	// Merge saved cart with current cart.
98	if ( is_null( $cart ) \|\| $merge_saved_cart ) {
99	$saved_cart = $this->get_saved_cart();
100	$cart = is_null( $cart ) ? array() : $cart;
101	$cart = array_merge( $saved_cart, $cart );
102	$update_cart_session = true;
103
104	delete_user_meta( get_current_user_id(), '_woocommerce_load_saved_cart_after_login' );
105	}
106
107	// Populate cart from order.
108	if ( isset( $_GET['order_again'], $_GET['_wpnonce'] ) && is_user_logged_in() && wp_verify_nonce( wp_unslash( $_GET['_wpnonce'] ), 'woocommerce-order_again' ) ) { // WPCS: input var ok, sanitization ok.
109	$cart = $this->populate_cart_from_order( absint( $_GET['order_again'] ), $cart ); // WPCS: input var ok.
110	$order_again = true;
111	}
112
113	// Prime caches to reduce future queries.
114	if ( is_callable( '_prime_post_caches' ) ) {
115	_prime_post_caches( wp_list_pluck( $cart, 'product_id' ) );
116	}
117
118	$cart_contents = array();
119
120	foreach ( $cart as $key => $values ) {
121	if ( ! is_customize_preview() && 'customize-preview' === $key ) {
122	continue;
123	}
124
125	$product = wc_get_product( $values['variation_id'] ? $values['variation_id'] : $values['product_id'] );
126
127	if ( empty( $product ) \|\| ! $product->exists() \|\| 0 >= $values['quantity'] ) {
128	continue;
129	}
130
131	/**
132	* Allow 3rd parties to validate this item before it's added to cart and add their own notices.
133	*
134	* @since 3.6.0
135	*
136	* @param bool $remove_cart_item_from_session If true, the item will not be added to the cart. Default: false.
137	* @param string $key Cart item key.
138	* @param array $values Cart item values e.g. quantity and product_id.
139	* @param WC_Product $product The product being added to the cart.
140	*/
141	if ( apply_filters( 'woocommerce_pre_remove_cart_item_from_session', false, $key, $values, $product ) ) {
142	$update_cart_session = true;
143	/**
144	* Fires when cart item is removed from the session.
145	*
146	* @since 3.6.0
147	*
148	* @param string $key Cart item key.
149	* @param array $values Cart item values e.g. quantity and product_id.
150	* @param WC_Product $product The product being added to the cart.
151	*/
152	do_action( 'woocommerce_remove_cart_item_from_session', $key, $values, $product );
153
154	/**
155	* Allow 3rd parties to override this item's is_purchasable() result with cart item data.
156	*
157	* @param bool $is_purchasable If false, the item will not be added to the cart. Default: product's is_purchasable() status.
158	* @param string $key Cart item key.
159	* @param array $values Cart item values e.g. quantity and product_id.
160	* @param WC_Product $product The product being added to the cart.
161	*
162	* @since 7.0.0
163	*/
164	} elseif ( ! apply_filters( 'woocommerce_cart_item_is_purchasable', $product->is_purchasable(), $key, $values, $product ) ) {
165	$update_cart_session = true;
166	/* translators: %s: product name */
167	$message = sprintf( __( '%s has been removed from your cart because it can no longer be purchased. Please contact us if you need assistance.', 'woocommerce' ), $product->get_name() );
168	/**
169	* Filter message about item removed from the cart.
170	*
171	* @since 3.8.0
172	* @param string $message Message.
173	* @param WC_Product $product Product data.
174	*/
175	$message = apply_filters( 'woocommerce_cart_item_removed_message', $message, $product );
176	wc_add_notice( $message, 'error' );
177	do_action( 'woocommerce_remove_cart_item_from_session', $key, $values );
178
179	} elseif ( ! empty( $values['data_hash'] ) && ! hash_equals( $values['data_hash'], wc_get_cart_item_data_hash( $product ) ) ) { // phpcs:ignore PHPCompatibility.PHP.NewFunctions.hash_equalsFound
180	$update_cart_session = true;
181	/* translators: %1$s: product name. %2$s product permalink */
182	$message = sprintf( __( '%1$s has been removed from your cart because it has since been modified. You can add it back to your cart <a href="%2$s">here</a>.', 'woocommerce' ), $product->get_name(), $product->get_permalink() );
183	$message = apply_filters( 'woocommerce_cart_item_removed_because_modified_message', $message, $product );
184	wc_add_notice( $message, 'notice' );
185	do_action( 'woocommerce_remove_cart_item_from_session', $key, $values );
186
187	} else {
188	// Put session data into array. Run through filter so other plugins can load their own session data.
189	$session_data = array_merge(
190	$values,
191	array(
192	'data' => $product,
193	)
194	);
195
196	$cart_contents[ $key ] = apply_filters( 'woocommerce_get_cart_item_from_session', $session_data, $values, $key );
197
198	// Add to cart right away so the product is visible in woocommerce_get_cart_item_from_session hook.
199	$this->cart->set_cart_contents( $cart_contents );
200	}
201	}
202
203	// If it's not empty, it's been already populated by the loop above.
204	if ( ! empty( $cart_contents ) ) {
205	$this->cart->set_cart_contents( apply_filters( 'woocommerce_cart_contents_changed', $cart_contents ) );
206	}
207
208	do_action( 'woocommerce_cart_loaded_from_session', $this->cart );
209
210	if ( $update_cart_session \|\| is_null( WC()->session->get( 'cart_totals', null ) ) ) {
211	WC()->session->set( 'cart', $this->get_cart_for_session() );
212	$this->cart->calculate_totals();
213
214	if ( $merge_saved_cart ) {
215	$this->persistent_cart_update();
216	}
217	}
218
219	// If this is a re-order, redirect to the cart page to get rid of the `order_again` query string.
220	if ( $order_again ) {
221	wp_safe_redirect( wc_get_cart_url() );
222	exit;
223	}
224	}
225
226	/**
227	* Destroy cart session data.
228	*
229	* @since 3.2.0
230	*/
231	public function destroy_cart_session() {
232	WC()->session->set( 'cart', null );
233	WC()->session->set( 'cart_totals', null );
234	WC()->session->set( 'applied_coupons', null );
235	WC()->session->set( 'coupon_discount_totals', null );
236	WC()->session->set( 'coupon_discount_tax_totals', null );
237	WC()->session->set( 'removed_cart_contents', null );
238	WC()->session->set( 'order_awaiting_payment', null );
239	}
240
241	/**
242	* Will set cart cookies if needed and when possible.
243	*
244	* @since 3.2.0
245	*/
246	public function maybe_set_cart_cookies() {
247	if ( ! headers_sent() && did_action( 'wp_loaded' ) ) {
248	if ( ! $this->cart->is_empty() ) {
249	$this->set_cart_cookies( true );
250	} elseif ( isset( $_COOKIE['woocommerce_items_in_cart'] ) ) { // WPCS: input var ok.
251	$this->set_cart_cookies( false );
252	}
253	}
254	}
255
256	/**
257	* Sets the php session data for the cart and coupons.
258	*/
259	public function set_session() {
260	WC()->session->set( 'cart', $this->get_cart_for_session() );
261	WC()->session->set( 'cart_totals', $this->cart->get_totals() );
262	WC()->session->set( 'applied_coupons', $this->cart->get_applied_coupons() );
263	WC()->session->set( 'coupon_discount_totals', $this->cart->get_coupon_discount_totals() );
264	WC()->session->set( 'coupon_discount_tax_totals', $this->cart->get_coupon_discount_tax_totals() );
265	WC()->session->set( 'removed_cart_contents', $this->cart->get_removed_cart_contents() );
266
267	do_action( 'woocommerce_cart_updated' );
268	}
269
270	/**
271	* Returns the contents of the cart in an array without the 'data' element.
272	*
273	* @return array contents of the cart
274	*/
275	public function get_cart_for_session() {
276	$cart_session = array();
277
278	foreach ( $this->cart->get_cart() as $key => $values ) {
279	$cart_session[ $key ] = $values;
280	unset( $cart_session[ $key ]['data'] ); // Unset product object.
281	}
282
283	return $cart_session;
284	}
285
286	/**
287	* Save the persistent cart when the cart is updated.
288	*/
289	public function persistent_cart_update() {
290	if ( get_current_user_id() && apply_filters( 'woocommerce_persistent_cart_enabled', true ) ) {
291	update_user_meta(
292	get_current_user_id(),
293	'_woocommerce_persistent_cart_' . get_current_blog_id(),
294	array(
295	'cart' => $this->get_cart_for_session(),
296	)
297	);
298	}
299	}
300
301	/**
302	* Delete the persistent cart permanently.
303	*/
304	public function persistent_cart_destroy() {
305	if ( get_current_user_id() && apply_filters( 'woocommerce_persistent_cart_enabled', true ) ) {
306	delete_user_meta( get_current_user_id(), '_woocommerce_persistent_cart_' . get_current_blog_id() );
307	}
308	}
309
310	/**
311	* Set cart hash cookie and items in cart if not already set.
312	*
313	* @param bool $set Should cookies be set (true) or unset.
314	*/
315	private function set_cart_cookies( $set = true ) {
316	if ( $set ) {
317	$setcookies = array(
318	'woocommerce_items_in_cart' => '1',
319	'woocommerce_cart_hash' => WC()->cart->get_cart_hash(),
320	);
321	foreach ( $setcookies as $name => $value ) {
322	if ( ! isset( $_COOKIE[ $name ] ) \|\| $_COOKIE[ $name ] !== $value ) {
323	wc_setcookie( $name, $value );
324	}
325	}
326	} else {
327	$unsetcookies = array(
328	'woocommerce_items_in_cart',
329	'woocommerce_cart_hash',
330	);
331	foreach ( $unsetcookies as $name ) {
332	if ( isset( $_COOKIE[ $name ] ) ) {
333	wc_setcookie( $name, 0, time() - HOUR_IN_SECONDS );
334	unset( $_COOKIE[ $name ] );
335	}
336	}
337	}
338
339	do_action( 'woocommerce_set_cart_cookies', $set );
340	}
341
342	/**
343	* Get the persistent cart from the database.
344	*
345	* @since 3.5.0
346	* @return array
347	*/
348	private function get_saved_cart() {
349	$saved_cart = array();
350
351	if ( apply_filters( 'woocommerce_persistent_cart_enabled', true ) ) {
352	$saved_cart_meta = get_user_meta( get_current_user_id(), '_woocommerce_persistent_cart_' . get_current_blog_id(), true );
353
354	if ( isset( $saved_cart_meta['cart'] ) ) {
355	$saved_cart = array_filter( (array) $saved_cart_meta['cart'] );
356	}
357	}
358
359	return $saved_cart;
360	}
361
362	/**
363	* Get a cart from an order, if user has permission.
364	*
365	* @since 3.5.0
366	*
367	* @param int $order_id Order ID to try to load.
368	* @param array $cart Current cart array.
369	*
370	* @return array
371	*/
372	private function populate_cart_from_order( $order_id, $cart ) {
373	$order = wc_get_order( $order_id );
374
375	if ( ! $order->get_id() \|\| ! $order->has_status( apply_filters( 'woocommerce_valid_order_statuses_for_order_again', array( 'completed' ) ) ) \|\| ! current_user_can( 'order_again', $order->get_id() ) ) {
376	return;
377	}
378
379	if ( apply_filters( 'woocommerce_empty_cart_when_order_again', true ) ) {
380	$cart = array();
381	}
382
383	$inital_cart_size = count( $cart );
384	$order_items = $order->get_items();
385
386	foreach ( $order_items as $item ) {
387	$product_id = (int) apply_filters( 'woocommerce_add_to_cart_product_id', $item->get_product_id() );
388	$quantity = $item->get_quantity();
389	$variation_id = (int) $item->get_variation_id();
390	$variations = array();
391	$cart_item_data = apply_filters( 'woocommerce_order_again_cart_item_data', array(), $item, $order );
392	$product = $item->get_product();
393
394	if ( ! $product ) {
395	continue;
396	}
397
398	// Prevent reordering variable products if no selected variation.
399	if ( ! $variation_id && $product->is_type( 'variable' ) ) {
400	continue;
401	}
402
403	// Prevent reordering items specifically out of stock.
404	if ( ! $product->is_in_stock() ) {
405	continue;
406	}
407
408	foreach ( $item->get_meta_data() as $meta ) {
409	if ( taxonomy_is_product_attribute( $meta->key ) \|\| meta_is_product_attribute( $meta->key, $meta->value, $product_id ) ) {
410	$variations[ $meta->key ] = $meta->value;
411	}
412	}
413
414	if ( ! apply_filters( 'woocommerce_add_to_cart_validation', true, $product_id, $quantity, $variation_id, $variations, $cart_item_data ) ) {
415	continue;
416	}
417
418	// Add to cart directly.
419	$cart_id = WC()->cart->generate_cart_id( $product_id, $variation_id, $variations, $cart_item_data );
420	$product_data = wc_get_product( $variation_id ? $variation_id : $product_id );
421	$cart[ $cart_id ] = apply_filters(
422	'woocommerce_add_order_again_cart_item',
423	array_merge(
424	$cart_item_data,
425	array(
426	'key' => $cart_id,
427	'product_id' => $product_id,
428	'variation_id' => $variation_id,
429	'variation' => $variations,
430	'quantity' => $quantity,
431	'data' => $product_data,
432	'data_hash' => wc_get_cart_item_data_hash( $product_data ),
433	)
434	),
435	$cart_id
436	);
437	}
438
439	do_action_ref_array( 'woocommerce_ordered_again', array( $order->get_id(), $order_items, &$cart ) );
440
441	$num_items_in_cart = count( $cart );
442	$num_items_in_original_order = count( $order_items );
443	$num_items_added = $num_items_in_cart - $inital_cart_size;
444
445	if ( $num_items_in_original_order > $num_items_added ) {
446	wc_add_notice(
447	sprintf(
448	/* translators: %d item count */
449	_n(
450	'%d item from your previous order is currently unavailable and could not be added to your cart.',
451	'%d items from your previous order are currently unavailable and could not be added to your cart.',
452	$num_items_in_original_order - $num_items_added,
453	'woocommerce'
454	),
455	$num_items_in_original_order - $num_items_added
456	),
457	'error'
458	);
459	}
460
461	if ( 0 < $num_items_added ) {
462	wc_add_notice( __( 'The cart has been filled with the items from your previous order.', 'woocommerce' ) );
463	}
464
465	return $cart;
466	}
467	}
468