wc-cart-functions.php — WooCommerce 8.6.2

woocommerce / includes / wc-cart-functions.php

woocommerce / includes Last commit date

wc-cart-functions.php

507 lines

1	<?php
2	/**
3	* WooCommerce Cart Functions
4	*
5	* Functions for cart specific things.
6	*
7	* @package WooCommerce\Functions
8	* @version 2.5.0
9	*/
10
11	use Automattic\Jetpack\Constants;
12
13	defined( 'ABSPATH' ) \|\| exit;
14
15	/**
16	* Prevent password protected products being added to the cart.
17	*
18	* @param bool $passed Validation.
19	* @param int $product_id Product ID.
20	* @return bool
21	*/
22	function wc_protected_product_add_to_cart( $passed, $product_id ) {
23	if ( post_password_required( $product_id ) ) {
24	$passed = false;
25	wc_add_notice( __( 'This product is protected and cannot be purchased.', 'woocommerce' ), 'error' );
26	}
27	return $passed;
28	}
29	add_filter( 'woocommerce_add_to_cart_validation', 'wc_protected_product_add_to_cart', 10, 2 );
30
31	/**
32	* Clears the cart session when called.
33	*/
34	function wc_empty_cart() {
35	if ( ! isset( WC()->cart ) \|\| '' === WC()->cart ) {
36	WC()->cart = new WC_Cart();
37	}
38	WC()->cart->empty_cart( false );
39	}
40
41	/**
42	* Load the persistent cart.
43	*
44	* @param string $user_login User login.
45	* @param WP_User $user User data.
46	* @deprecated 2.3
47	*/
48	function wc_load_persistent_cart( $user_login, $user ) {
49	if ( ! $user \|\| ! apply_filters( 'woocommerce_persistent_cart_enabled', true ) ) {
50	return;
51	}
52
53	$saved_cart = get_user_meta( $user->ID, '_woocommerce_persistent_cart_' . get_current_blog_id(), true );
54
55	if ( ! $saved_cart ) {
56	return;
57	}
58
59	$cart = WC()->session->cart;
60
61	if ( empty( $cart ) \|\| ! is_array( $cart ) \|\| 0 === count( $cart ) ) {
62	WC()->session->cart = $saved_cart['cart'];
63	}
64	}
65
66	/**
67	* Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
68	*
69	* Do not use for redirects, use {@see wp_get_referer()} instead.
70	*
71	* @since 2.6.1
72	* @return string\|false Referer URL on success, false on failure.
73	*/
74	function wc_get_raw_referer() {
75	if ( function_exists( 'wp_get_raw_referer' ) ) {
76	return wp_get_raw_referer();
77	}
78
79	if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) { // WPCS: input var ok, CSRF ok.
80	return wp_unslash( $_REQUEST['_wp_http_referer'] ); // WPCS: input var ok, CSRF ok, sanitization ok.
81	} elseif ( ! empty( $_SERVER['HTTP_REFERER'] ) ) { // WPCS: input var ok, CSRF ok.
82	return wp_unslash( $_SERVER['HTTP_REFERER'] ); // WPCS: input var ok, CSRF ok, sanitization ok.
83	}
84
85	return false;
86	}
87
88	/**
89	* Add to cart messages.
90	*
91	* @param int\|array $products Product ID list or single product ID.
92	* @param bool $show_qty Should quantities be shown? Added in 2.6.0.
93	* @param bool $return Return message rather than add it.
94	*
95	* @return mixed
96	*/
97	function wc_add_to_cart_message( $products, $show_qty = false, $return = false ) {
98	$titles = array();
99	$count = 0;
100
101	if ( ! is_array( $products ) ) {
102	$products = array( $products => 1 );
103	$show_qty = false;
104	}
105
106	if ( ! $show_qty ) {
107	$products = array_fill_keys( array_keys( $products ), 1 );
108	}
109
110	foreach ( $products as $product_id => $qty ) {
111	/* translators: %s: product name */
112	$titles[] = apply_filters( 'woocommerce_add_to_cart_qty_html', ( $qty > 1 ? absint( $qty ) . ' × ' : '' ), $product_id ) . apply_filters( 'woocommerce_add_to_cart_item_name_in_quotes', sprintf( _x( '“%s”', 'Item name in quotes', 'woocommerce' ), strip_tags( get_the_title( $product_id ) ) ), $product_id );
113	$count += $qty;
114	}
115
116	$titles = array_filter( $titles );
117	/* translators: %s: product name */
118	$added_text = sprintf( _n( '%s has been added to your cart.', '%s have been added to your cart.', $count, 'woocommerce' ), wc_format_list_of_items( $titles ) );
119
120	// Output success messages.
121	$wp_button_class = wc_wp_theme_get_element_class_name( 'button' ) ? ' ' . wc_wp_theme_get_element_class_name( 'button' ) : '';
122	if ( 'yes' === get_option( 'woocommerce_cart_redirect_after_add' ) ) {
123	$return_to = apply_filters( 'woocommerce_continue_shopping_redirect', wc_get_raw_referer() ? wp_validate_redirect( wc_get_raw_referer(), false ) : wc_get_page_permalink( 'shop' ) );
124	$message = sprintf( '<a href="%s" tabindex="1" class="button wc-forward%s">%s</a> %s', esc_url( $return_to ), esc_attr( $wp_button_class ), esc_html__( 'Continue shopping', 'woocommerce' ), esc_html( $added_text ) );
125	} else {
126	$message = sprintf( '<a href="%s" tabindex="1" class="button wc-forward%s">%s</a> %s', esc_url( wc_get_cart_url() ), esc_attr( $wp_button_class ), esc_html__( 'View cart', 'woocommerce' ), esc_html( $added_text ) );
127	}
128
129	if ( has_filter( 'wc_add_to_cart_message' ) ) {
130	wc_deprecated_function( 'The wc_add_to_cart_message filter', '3.0', 'wc_add_to_cart_message_html' );
131	$message = apply_filters( 'wc_add_to_cart_message', $message, $product_id );
132	}
133
134	$message = apply_filters( 'wc_add_to_cart_message_html', $message, $products, $show_qty );
135
136	if ( $return ) {
137	return $message;
138	} else {
139	wc_add_notice( $message, apply_filters( 'woocommerce_add_to_cart_notice_type', 'success' ) );
140	}
141	}
142
143	/**
144	* Comma separate a list of item names, and replace final comma with 'and'.
145	*
146	* @param array $items Cart items.
147	* @return string
148	*/
149	function wc_format_list_of_items( $items ) {
150	$item_string = '';
151
152	foreach ( $items as $key => $item ) {
153	$item_string .= $item;
154
155	if ( count( $items ) === $key + 2 ) {
156	$item_string .= ' ' . __( 'and', 'woocommerce' ) . ' ';
157	} elseif ( count( $items ) !== $key + 1 ) {
158	$item_string .= ', ';
159	}
160	}
161
162	return $item_string;
163	}
164
165	/**
166	* Clear cart after payment.
167	*/
168	function wc_clear_cart_after_payment() {
169	global $wp;
170
171	if ( ! empty( $wp->query_vars['order-received'] ) ) {
172
173	$order_id = absint( $wp->query_vars['order-received'] );
174	$order_key = isset( $_GET['key'] ) ? wc_clean( wp_unslash( $_GET['key'] ) ) : ''; // WPCS: input var ok, CSRF ok.
175
176	if ( $order_id > 0 ) {
177	$order = wc_get_order( $order_id );
178
179	if ( $order instanceof WC_Order && hash_equals( $order->get_order_key(), $order_key ) ) {
180	WC()->cart->empty_cart();
181	}
182	}
183	}
184
185	if ( WC()->session->order_awaiting_payment > 0 ) {
186	$order = wc_get_order( WC()->session->order_awaiting_payment );
187
188	if ( $order instanceof WC_Order && $order->get_id() > 0 ) {
189	// If the order has not failed, or is not pending, the order must have gone through.
190	if ( ! $order->has_status( array( 'failed', 'pending', 'cancelled' ) ) ) {
191	WC()->cart->empty_cart();
192	}
193	}
194	}
195	}
196	add_action( 'template_redirect', 'wc_clear_cart_after_payment', 20 );
197
198	/**
199	* Get the subtotal.
200	*/
201	function wc_cart_totals_subtotal_html() {
202	echo WC()->cart->get_cart_subtotal(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
203	}
204
205	/**
206	* Get shipping methods.
207	*/
208	function wc_cart_totals_shipping_html() {
209	$packages = WC()->shipping()->get_packages();
210	$first = true;
211
212	foreach ( $packages as $i => $package ) {
213	$chosen_method = isset( WC()->session->chosen_shipping_methods[ $i ] ) ? WC()->session->chosen_shipping_methods[ $i ] : '';
214	$product_names = array();
215
216	if ( count( $packages ) > 1 ) {
217	foreach ( $package['contents'] as $item_id => $values ) {
218	$product_names[ $item_id ] = $values['data']->get_name() . ' ×' . $values['quantity'];
219	}
220	$product_names = apply_filters( 'woocommerce_shipping_package_details_array', $product_names, $package );
221	}
222
223	wc_get_template(
224	'cart/cart-shipping.php',
225	array(
226	'package' => $package,
227	'available_methods' => $package['rates'],
228	'show_package_details' => count( $packages ) > 1,
229	'show_shipping_calculator' => is_cart() && apply_filters( 'woocommerce_shipping_show_shipping_calculator', $first, $i, $package ),
230	'package_details' => implode( ', ', $product_names ),
231	/* translators: %d: shipping package number */
232	'package_name' => apply_filters( 'woocommerce_shipping_package_name', ( ( $i + 1 ) > 1 ) ? sprintf( _x( 'Shipping %d', 'shipping packages', 'woocommerce' ), ( $i + 1 ) ) : _x( 'Shipping', 'shipping packages', 'woocommerce' ), $i, $package ),
233	'index' => $i,
234	'chosen_method' => $chosen_method,
235	'formatted_destination' => WC()->countries->get_formatted_address( $package['destination'], ', ' ),
236	'has_calculated_shipping' => WC()->customer->has_calculated_shipping(),
237	)
238	);
239
240	$first = false;
241	}
242	}
243
244	/**
245	* Get taxes total.
246	*/
247	function wc_cart_totals_taxes_total_html() {
248	echo apply_filters( 'woocommerce_cart_totals_taxes_total_html', wc_price( WC()->cart->get_taxes_total() ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
249	}
250
251	/**
252	* Get a coupon label.
253	*
254	* @param string\|WC_Coupon $coupon Coupon data or code.
255	* @param bool $echo Echo or return.
256	*
257	* @return string
258	*/
259	function wc_cart_totals_coupon_label( $coupon, $echo = true ) {
260	if ( is_string( $coupon ) ) {
261	$coupon = new WC_Coupon( $coupon );
262	}
263
264	/* translators: %s: coupon code */
265	$label = apply_filters( 'woocommerce_cart_totals_coupon_label', sprintf( esc_html__( 'Coupon: %s', 'woocommerce' ), $coupon->get_code() ), $coupon );
266
267	if ( $echo ) {
268	echo $label; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
269	} else {
270	return $label;
271	}
272	}
273
274	/**
275	* Get coupon display HTML.
276	*
277	* @param string\|WC_Coupon $coupon Coupon data or code.
278	*/
279	function wc_cart_totals_coupon_html( $coupon ) {
280	if ( is_string( $coupon ) ) {
281	$coupon = new WC_Coupon( $coupon );
282	}
283
284	$discount_amount_html = '';
285
286	$amount = WC()->cart->get_coupon_discount_amount( $coupon->get_code(), WC()->cart->display_cart_ex_tax );
287	$discount_amount_html = '-' . wc_price( $amount );
288
289	if ( $coupon->get_free_shipping() && empty( $amount ) ) {
290	$discount_amount_html = __( 'Free shipping coupon', 'woocommerce' );
291	}
292
293	$discount_amount_html = apply_filters( 'woocommerce_coupon_discount_amount_html', $discount_amount_html, $coupon );
294	$coupon_html = $discount_amount_html . ' <a href="' . esc_url( add_query_arg( 'remove_coupon', rawurlencode( $coupon->get_code() ), Constants::is_defined( 'WOOCOMMERCE_CHECKOUT' ) ? wc_get_checkout_url() : wc_get_cart_url() ) ) . '" class="woocommerce-remove-coupon" data-coupon="' . esc_attr( $coupon->get_code() ) . '">' . __( '[Remove]', 'woocommerce' ) . '</a>';
295
296	echo wp_kses( apply_filters( 'woocommerce_cart_totals_coupon_html', $coupon_html, $coupon, $discount_amount_html ), array_replace_recursive( wp_kses_allowed_html( 'post' ), array( 'a' => array( 'data-coupon' => true ) ) ) ); // phpcs:ignore PHPCompatibility.PHP.NewFunctions.array_replace_recursiveFound
297	}
298
299	/**
300	* Get order total html including inc tax if needed.
301	*/
302	function wc_cart_totals_order_total_html() {
303	$value = '<strong>' . WC()->cart->get_total() . '</strong> ';
304
305	// If prices are tax inclusive, show taxes here.
306	if ( wc_tax_enabled() && WC()->cart->display_prices_including_tax() ) {
307	$tax_string_array = array();
308	$cart_tax_totals = WC()->cart->get_tax_totals();
309
310	if ( get_option( 'woocommerce_tax_total_display' ) === 'itemized' ) {
311	foreach ( $cart_tax_totals as $code => $tax ) {
312	$tax_string_array[] = sprintf( '%s %s', $tax->formatted_amount, $tax->label );
313	}
314	} elseif ( ! empty( $cart_tax_totals ) ) {
315	$tax_string_array[] = sprintf( '%s %s', wc_price( WC()->cart->get_taxes_total( true, true ) ), WC()->countries->tax_or_vat() );
316	}
317
318	if ( ! empty( $tax_string_array ) ) {
319	$taxable_address = WC()->customer->get_taxable_address();
320	if ( WC()->customer->is_customer_outside_base() && ! WC()->customer->has_calculated_shipping() ) {
321	$country = WC()->countries->estimated_for_prefix( $taxable_address[0] ) . WC()->countries->countries[ $taxable_address[0] ];
322	/* translators: 1: tax amount 2: country name */
323	$tax_text = wp_kses_post( sprintf( __( '(includes %1$s estimated for %2$s)', 'woocommerce' ), implode( ', ', $tax_string_array ), $country ) );
324	} else {
325	/* translators: %s: tax amount */
326	$tax_text = wp_kses_post( sprintf( __( '(includes %s)', 'woocommerce' ), implode( ', ', $tax_string_array ) ) );
327	}
328
329	$value .= '<small class="includes_tax">' . $tax_text . '</small>';
330	}
331	}
332
333	echo apply_filters( 'woocommerce_cart_totals_order_total_html', $value ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
334	}
335
336	/**
337	* Get the fee value.
338	*
339	* @param object $fee Fee data.
340	*/
341	function wc_cart_totals_fee_html( $fee ) {
342	$cart_totals_fee_html = WC()->cart->display_prices_including_tax() ? wc_price( $fee->total + $fee->tax ) : wc_price( $fee->total );
343
344	echo apply_filters( 'woocommerce_cart_totals_fee_html', $cart_totals_fee_html, $fee ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
345	}
346
347	/**
348	* Get a shipping methods full label including price.
349	*
350	* @param WC_Shipping_Rate $method Shipping method rate data.
351	* @return string
352	*/
353	function wc_cart_totals_shipping_method_label( $method ) {
354	$label = $method->get_label();
355	$has_cost = 0 < $method->cost;
356	$hide_cost = ! $has_cost && in_array( $method->get_method_id(), array( 'free_shipping', 'local_pickup' ), true );
357
358	if ( $has_cost && ! $hide_cost ) {
359	if ( WC()->cart->display_prices_including_tax() ) {
360	$label .= ': ' . wc_price( $method->cost + $method->get_shipping_tax() );
361	if ( $method->get_shipping_tax() > 0 && ! wc_prices_include_tax() ) {
362	$label .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
363	}
364	} else {
365	$label .= ': ' . wc_price( $method->cost );
366	if ( $method->get_shipping_tax() > 0 && wc_prices_include_tax() ) {
367	$label .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
368	}
369	}
370	}
371
372	return apply_filters( 'woocommerce_cart_shipping_method_full_label', $label, $method );
373	}
374
375	/**
376	* Round discount.
377	*
378	* @param double $value Amount to round.
379	* @param int $precision DP to round.
380	* @return float
381	*/
382	function wc_cart_round_discount( $value, $precision ) {
383	return wc_round_discount( $value, $precision );
384	}
385
386	/**
387	* Gets chosen shipping method IDs from chosen_shipping_methods session, without instance IDs.
388	*
389	* @since 2.6.2
390	* @return string[]
391	*/
392	function wc_get_chosen_shipping_method_ids() {
393	$method_ids = array();
394	$chosen_methods = WC()->session->get( 'chosen_shipping_methods', array() );
395	foreach ( $chosen_methods as $chosen_method ) {
396	$chosen_method = explode( ':', $chosen_method );
397	$method_ids[] = current( $chosen_method );
398	}
399	return $method_ids;
400	}
401
402	/**
403	* Get chosen method for package from session.
404	*
405	* @since 3.2.0
406	* @param int $key Key of package.
407	* @param array $package Package data array.
408	* @return string\|bool
409	*/
410	function wc_get_chosen_shipping_method_for_package( $key, $package ) {
411	$chosen_methods = WC()->session->get( 'chosen_shipping_methods' );
412	$chosen_method = isset( $chosen_methods[ $key ] ) ? $chosen_methods[ $key ] : false;
413	$changed = wc_shipping_methods_have_changed( $key, $package );
414
415	// This is deprecated but here for BW compat. TODO: Remove in 4.0.0.
416	$method_counts = WC()->session->get( 'shipping_method_counts' );
417
418	if ( ! empty( $method_counts[ $key ] ) ) {
419	$method_count = absint( $method_counts[ $key ] );
420	} else {
421	$method_count = 0;
422	}
423
424	// If not set, not available, or available methods have changed, set to the DEFAULT option.
425	if ( ! $chosen_method \|\| $changed \|\| ! isset( $package['rates'][ $chosen_method ] ) \|\| count( $package['rates'] ) !== $method_count ) {
426	$chosen_method = wc_get_default_shipping_method_for_package( $key, $package, $chosen_method );
427	$chosen_methods[ $key ] = $chosen_method;
428	$method_counts[ $key ] = count( $package['rates'] );
429
430	WC()->session->set( 'chosen_shipping_methods', $chosen_methods );
431	WC()->session->set( 'shipping_method_counts', $method_counts );
432
433	do_action( 'woocommerce_shipping_method_chosen', $chosen_method );
434	}
435	return $chosen_method;
436	}
437
438	/**
439	* Choose the default method for a package.
440	*
441	* @since 3.2.0
442	* @param int $key Key of package.
443	* @param array $package Package data array.
444	* @param string $chosen_method Chosen method id.
445	* @return string
446	*/
447	function wc_get_default_shipping_method_for_package( $key, $package, $chosen_method ) {
448	$rate_keys = array_keys( $package['rates'] );
449	$default = current( $rate_keys );
450	$coupons = WC()->cart->get_coupons();
451	foreach ( $coupons as $coupon ) {
452	if ( $coupon->get_free_shipping() ) {
453	foreach ( $rate_keys as $rate_key ) {
454	if ( 0 === stripos( $rate_key, 'free_shipping' ) ) {
455	$default = $rate_key;
456	break;
457	}
458	}
459	break;
460	}
461	}
462	return apply_filters( 'woocommerce_shipping_chosen_method', $default, $package['rates'], $chosen_method );
463	}
464
465	/**
466	* See if the methods have changed since the last request.
467	*
468	* @since 3.2.0
469	* @param int $key Key of package.
470	* @param array $package Package data array.
471	* @return bool
472	*/
473	function wc_shipping_methods_have_changed( $key, $package ) {
474	// Lookup previous methods from session.
475	$previous_shipping_methods = WC()->session->get( 'previous_shipping_methods' );
476	// Get new and old rates.
477	$new_rates = array_keys( $package['rates'] );
478	$prev_rates = isset( $previous_shipping_methods[ $key ] ) ? $previous_shipping_methods[ $key ] : false;
479	// Update session.
480	$previous_shipping_methods[ $key ] = $new_rates;
481	WC()->session->set( 'previous_shipping_methods', $previous_shipping_methods );
482	return $new_rates !== $prev_rates;
483	}
484
485	/**
486	* Gets a hash of important product data that when changed should cause cart items to be invalidated.
487	*
488	* The woocommerce_cart_item_data_to_validate filter can be used to add custom properties.
489	*
490	* @param WC_Product $product Product object.
491	* @return string
492	*/
493	function wc_get_cart_item_data_hash( $product ) {
494	return md5(
495	wp_json_encode(
496	apply_filters(
497	'woocommerce_cart_item_data_to_validate',
498	array(
499	'type' => $product->get_type(),
500	'attributes' => 'variation' === $product->get_type() ? $product->get_variation_attributes() : '',
501	),
502	$product
503	)
504	)
505	);
506	}
507