436 lines
15 KiB
PHP
436 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* Cart session handling class.
|
|
*
|
|
* @package WooCommerce\Classes
|
|
* @version 3.2.0
|
|
*/
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* WC_Cart_Session class.
|
|
*
|
|
* @since 3.2.0
|
|
*/
|
|
final class WC_Cart_Session {
|
|
|
|
/**
|
|
* Reference to cart object.
|
|
*
|
|
* @since 3.2.0
|
|
* @var WC_Cart
|
|
*/
|
|
protected $cart;
|
|
|
|
/**
|
|
* Sets up the items provided, and calculate totals.
|
|
*
|
|
* @since 3.2.0
|
|
* @throws Exception If missing WC_Cart object.
|
|
*
|
|
* @param WC_Cart $cart Cart object to calculate totals for.
|
|
*/
|
|
public function __construct( &$cart ) {
|
|
if ( ! is_a( $cart, 'WC_Cart' ) ) {
|
|
throw new Exception( 'A valid WC_Cart object is required' );
|
|
}
|
|
|
|
$this->cart = $cart;
|
|
}
|
|
|
|
/**
|
|
* Register methods for this object on the appropriate WordPress hooks.
|
|
*/
|
|
public function init() {
|
|
add_action( 'wp_loaded', array( $this, 'get_cart_from_session' ) );
|
|
add_action( 'woocommerce_cart_emptied', array( $this, 'destroy_cart_session' ) );
|
|
add_action( 'woocommerce_after_calculate_totals', array( $this, 'set_session' ) );
|
|
add_action( 'woocommerce_cart_loaded_from_session', array( $this, 'set_session' ) );
|
|
add_action( 'woocommerce_removed_coupon', array( $this, 'set_session' ) );
|
|
|
|
// Persistent cart stored to usermeta.
|
|
add_action( 'woocommerce_add_to_cart', array( $this, 'persistent_cart_update' ) );
|
|
add_action( 'woocommerce_cart_item_removed', array( $this, 'persistent_cart_update' ) );
|
|
add_action( 'woocommerce_cart_item_restored', array( $this, 'persistent_cart_update' ) );
|
|
add_action( 'woocommerce_cart_item_set_quantity', array( $this, 'persistent_cart_update' ) );
|
|
|
|
// Cookie events - cart cookies need to be set before headers are sent.
|
|
add_action( 'woocommerce_add_to_cart', array( $this, 'maybe_set_cart_cookies' ) );
|
|
add_action( 'wp', array( $this, 'maybe_set_cart_cookies' ), 99 );
|
|
add_action( 'shutdown', array( $this, 'maybe_set_cart_cookies' ), 0 );
|
|
}
|
|
|
|
/**
|
|
* Get the cart data from the PHP session and store it in class variables.
|
|
*
|
|
* @since 3.2.0
|
|
*/
|
|
public function get_cart_from_session() {
|
|
do_action( 'woocommerce_load_cart_from_session' );
|
|
$this->cart->set_totals( WC()->session->get( 'cart_totals', null ) );
|
|
$this->cart->set_applied_coupons( WC()->session->get( 'applied_coupons', array() ) );
|
|
$this->cart->set_coupon_discount_totals( WC()->session->get( 'coupon_discount_totals', array() ) );
|
|
$this->cart->set_coupon_discount_tax_totals( WC()->session->get( 'coupon_discount_tax_totals', array() ) );
|
|
$this->cart->set_removed_cart_contents( WC()->session->get( 'removed_cart_contents', array() ) );
|
|
|
|
$update_cart_session = false; // Flag to indicate the stored cart should be updated.
|
|
$order_again = false; // Flag to indicate whether this is a re-order.
|
|
$cart = WC()->session->get( 'cart', null );
|
|
$merge_saved_cart = (bool) get_user_meta( get_current_user_id(), '_woocommerce_load_saved_cart_after_login', true );
|
|
|
|
// Merge saved cart with current cart.
|
|
if ( is_null( $cart ) || $merge_saved_cart ) {
|
|
$saved_cart = $this->get_saved_cart();
|
|
$cart = is_null( $cart ) ? array() : $cart;
|
|
$cart = array_merge( $saved_cart, $cart );
|
|
$update_cart_session = true;
|
|
|
|
delete_user_meta( get_current_user_id(), '_woocommerce_load_saved_cart_after_login' );
|
|
}
|
|
|
|
// Populate cart from order.
|
|
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.
|
|
$cart = $this->populate_cart_from_order( absint( $_GET['order_again'] ), $cart ); // WPCS: input var ok.
|
|
$order_again = true;
|
|
}
|
|
|
|
// Prime caches to reduce future queries.
|
|
if ( is_callable( '_prime_post_caches' ) ) {
|
|
_prime_post_caches( wp_list_pluck( $cart, 'product_id' ) );
|
|
}
|
|
|
|
$cart_contents = array();
|
|
|
|
foreach ( $cart as $key => $values ) {
|
|
if ( ! is_customize_preview() && 'customize-preview' === $key ) {
|
|
continue;
|
|
}
|
|
|
|
$product = wc_get_product( $values['variation_id'] ? $values['variation_id'] : $values['product_id'] );
|
|
|
|
if ( empty( $product ) || ! $product->exists() || 0 >= $values['quantity'] ) {
|
|
continue;
|
|
}
|
|
|
|
/**
|
|
* Allow 3rd parties to validate this item before it's added to cart and add their own notices.
|
|
*
|
|
* @since 3.6.0
|
|
*
|
|
* @param bool $remove_cart_item_from_session If true, the item will not be added to the cart. Default: false.
|
|
* @param string $key Cart item key.
|
|
* @param array $values Cart item values e.g. quantity and product_id.
|
|
*/
|
|
if ( apply_filters( 'woocommerce_pre_remove_cart_item_from_session', false, $key, $values ) ) {
|
|
$update_cart_session = true;
|
|
do_action( 'woocommerce_remove_cart_item_from_session', $key, $values );
|
|
|
|
} elseif ( ! $product->is_purchasable() ) {
|
|
$update_cart_session = true;
|
|
/* translators: %s: product name */
|
|
$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() );
|
|
/**
|
|
* Filter message about item removed from the cart.
|
|
*
|
|
* @since 3.8.0
|
|
* @param string $message Message.
|
|
* @param WC_Product $product Product data.
|
|
*/
|
|
$message = apply_filters( 'woocommerce_cart_item_removed_message', $message, $product );
|
|
wc_add_notice( $message, 'error' );
|
|
do_action( 'woocommerce_remove_cart_item_from_session', $key, $values );
|
|
|
|
} elseif ( ! empty( $values['data_hash'] ) && ! hash_equals( $values['data_hash'], wc_get_cart_item_data_hash( $product ) ) ) { // phpcs:ignore PHPCompatibility.PHP.NewFunctions.hash_equalsFound
|
|
$update_cart_session = true;
|
|
/* translators: %1$s: product name. %2$s product permalink */
|
|
wc_add_notice( 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() ), 'notice' );
|
|
do_action( 'woocommerce_remove_cart_item_from_session', $key, $values );
|
|
|
|
} else {
|
|
// Put session data into array. Run through filter so other plugins can load their own session data.
|
|
$session_data = array_merge(
|
|
$values,
|
|
array(
|
|
'data' => $product,
|
|
)
|
|
);
|
|
|
|
$cart_contents[ $key ] = apply_filters( 'woocommerce_get_cart_item_from_session', $session_data, $values, $key );
|
|
|
|
// Add to cart right away so the product is visible in woocommerce_get_cart_item_from_session hook.
|
|
$this->cart->set_cart_contents( $cart_contents );
|
|
}
|
|
}
|
|
|
|
// If it's not empty, it's been already populated by the loop above.
|
|
if ( ! empty( $cart_contents ) ) {
|
|
$this->cart->set_cart_contents( apply_filters( 'woocommerce_cart_contents_changed', $cart_contents ) );
|
|
}
|
|
|
|
do_action( 'woocommerce_cart_loaded_from_session', $this->cart );
|
|
|
|
if ( $update_cart_session || is_null( WC()->session->get( 'cart_totals', null ) ) ) {
|
|
WC()->session->set( 'cart', $this->get_cart_for_session() );
|
|
$this->cart->calculate_totals();
|
|
|
|
if ( $merge_saved_cart ) {
|
|
$this->persistent_cart_update();
|
|
}
|
|
}
|
|
|
|
// If this is a re-order, redirect to the cart page to get rid of the `order_again` query string.
|
|
if ( $order_again ) {
|
|
wp_safe_redirect( wc_get_cart_url() );
|
|
exit;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Destroy cart session data.
|
|
*
|
|
* @since 3.2.0
|
|
*/
|
|
public function destroy_cart_session() {
|
|
WC()->session->set( 'cart', null );
|
|
WC()->session->set( 'cart_totals', null );
|
|
WC()->session->set( 'applied_coupons', null );
|
|
WC()->session->set( 'coupon_discount_totals', null );
|
|
WC()->session->set( 'coupon_discount_tax_totals', null );
|
|
WC()->session->set( 'removed_cart_contents', null );
|
|
WC()->session->set( 'order_awaiting_payment', null );
|
|
}
|
|
|
|
/**
|
|
* Will set cart cookies if needed and when possible.
|
|
*
|
|
* @since 3.2.0
|
|
*/
|
|
public function maybe_set_cart_cookies() {
|
|
if ( ! headers_sent() && did_action( 'wp_loaded' ) ) {
|
|
if ( ! $this->cart->is_empty() ) {
|
|
$this->set_cart_cookies( true );
|
|
} elseif ( isset( $_COOKIE['woocommerce_items_in_cart'] ) ) { // WPCS: input var ok.
|
|
$this->set_cart_cookies( false );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets the php session data for the cart and coupons.
|
|
*/
|
|
public function set_session() {
|
|
WC()->session->set( 'cart', $this->get_cart_for_session() );
|
|
WC()->session->set( 'cart_totals', $this->cart->get_totals() );
|
|
WC()->session->set( 'applied_coupons', $this->cart->get_applied_coupons() );
|
|
WC()->session->set( 'coupon_discount_totals', $this->cart->get_coupon_discount_totals() );
|
|
WC()->session->set( 'coupon_discount_tax_totals', $this->cart->get_coupon_discount_tax_totals() );
|
|
WC()->session->set( 'removed_cart_contents', $this->cart->get_removed_cart_contents() );
|
|
|
|
do_action( 'woocommerce_cart_updated' );
|
|
}
|
|
|
|
/**
|
|
* Returns the contents of the cart in an array without the 'data' element.
|
|
*
|
|
* @return array contents of the cart
|
|
*/
|
|
public function get_cart_for_session() {
|
|
$cart_session = array();
|
|
|
|
foreach ( $this->cart->get_cart() as $key => $values ) {
|
|
$cart_session[ $key ] = $values;
|
|
unset( $cart_session[ $key ]['data'] ); // Unset product object.
|
|
}
|
|
|
|
return $cart_session;
|
|
}
|
|
|
|
/**
|
|
* Save the persistent cart when the cart is updated.
|
|
*/
|
|
public function persistent_cart_update() {
|
|
if ( get_current_user_id() && apply_filters( 'woocommerce_persistent_cart_enabled', true ) ) {
|
|
update_user_meta(
|
|
get_current_user_id(),
|
|
'_woocommerce_persistent_cart_' . get_current_blog_id(),
|
|
array(
|
|
'cart' => $this->get_cart_for_session(),
|
|
)
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete the persistent cart permanently.
|
|
*/
|
|
public function persistent_cart_destroy() {
|
|
if ( get_current_user_id() && apply_filters( 'woocommerce_persistent_cart_enabled', true ) ) {
|
|
delete_user_meta( get_current_user_id(), '_woocommerce_persistent_cart_' . get_current_blog_id() );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set cart hash cookie and items in cart if not already set.
|
|
*
|
|
* @param bool $set Should cookies be set (true) or unset.
|
|
*/
|
|
private function set_cart_cookies( $set = true ) {
|
|
if ( $set ) {
|
|
$setcookies = array(
|
|
'woocommerce_items_in_cart' => '1',
|
|
'woocommerce_cart_hash' => WC()->cart->get_cart_hash(),
|
|
);
|
|
foreach ( $setcookies as $name => $value ) {
|
|
if ( ! isset( $_COOKIE[ $name ] ) || $_COOKIE[ $name ] !== $value ) {
|
|
wc_setcookie( $name, $value );
|
|
}
|
|
}
|
|
} else {
|
|
$unsetcookies = array(
|
|
'woocommerce_items_in_cart',
|
|
'woocommerce_cart_hash',
|
|
);
|
|
foreach ( $unsetcookies as $name ) {
|
|
if ( isset( $_COOKIE[ $name ] ) ) {
|
|
wc_setcookie( $name, 0, time() - HOUR_IN_SECONDS );
|
|
unset( $_COOKIE[ $name ] );
|
|
}
|
|
}
|
|
}
|
|
|
|
do_action( 'woocommerce_set_cart_cookies', $set );
|
|
}
|
|
|
|
/**
|
|
* Get the persistent cart from the database.
|
|
*
|
|
* @since 3.5.0
|
|
* @return array
|
|
*/
|
|
private function get_saved_cart() {
|
|
$saved_cart = array();
|
|
|
|
if ( apply_filters( 'woocommerce_persistent_cart_enabled', true ) ) {
|
|
$saved_cart_meta = get_user_meta( get_current_user_id(), '_woocommerce_persistent_cart_' . get_current_blog_id(), true );
|
|
|
|
if ( isset( $saved_cart_meta['cart'] ) ) {
|
|
$saved_cart = array_filter( (array) $saved_cart_meta['cart'] );
|
|
}
|
|
}
|
|
|
|
return $saved_cart;
|
|
}
|
|
|
|
/**
|
|
* Get a cart from an order, if user has permission.
|
|
*
|
|
* @since 3.5.0
|
|
*
|
|
* @param int $order_id Order ID to try to load.
|
|
* @param array $cart Current cart array.
|
|
*
|
|
* @return array
|
|
*/
|
|
private function populate_cart_from_order( $order_id, $cart ) {
|
|
$order = wc_get_order( $order_id );
|
|
|
|
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() ) ) {
|
|
return;
|
|
}
|
|
|
|
if ( apply_filters( 'woocommerce_empty_cart_when_order_again', true ) ) {
|
|
$cart = array();
|
|
}
|
|
|
|
$inital_cart_size = count( $cart );
|
|
$order_items = $order->get_items();
|
|
|
|
foreach ( $order_items as $item ) {
|
|
$product_id = (int) apply_filters( 'woocommerce_add_to_cart_product_id', $item->get_product_id() );
|
|
$quantity = $item->get_quantity();
|
|
$variation_id = (int) $item->get_variation_id();
|
|
$variations = array();
|
|
$cart_item_data = apply_filters( 'woocommerce_order_again_cart_item_data', array(), $item, $order );
|
|
$product = $item->get_product();
|
|
|
|
if ( ! $product ) {
|
|
continue;
|
|
}
|
|
|
|
// Prevent reordering variable products if no selected variation.
|
|
if ( ! $variation_id && $product->is_type( 'variable' ) ) {
|
|
continue;
|
|
}
|
|
|
|
// Prevent reordering items specifically out of stock.
|
|
if ( ! $product->is_in_stock() ) {
|
|
continue;
|
|
}
|
|
|
|
foreach ( $item->get_meta_data() as $meta ) {
|
|
if ( taxonomy_is_product_attribute( $meta->key ) ) {
|
|
$term = get_term_by( 'slug', $meta->value, $meta->key );
|
|
$variations[ $meta->key ] = $term ? $term->name : $meta->value;
|
|
} elseif ( meta_is_product_attribute( $meta->key, $meta->value, $product_id ) ) {
|
|
$variations[ $meta->key ] = $meta->value;
|
|
}
|
|
}
|
|
|
|
if ( ! apply_filters( 'woocommerce_add_to_cart_validation', true, $product_id, $quantity, $variation_id, $variations, $cart_item_data ) ) {
|
|
continue;
|
|
}
|
|
|
|
// Add to cart directly.
|
|
$cart_id = WC()->cart->generate_cart_id( $product_id, $variation_id, $variations, $cart_item_data );
|
|
$product_data = wc_get_product( $variation_id ? $variation_id : $product_id );
|
|
$cart[ $cart_id ] = apply_filters(
|
|
'woocommerce_add_order_again_cart_item',
|
|
array_merge(
|
|
$cart_item_data,
|
|
array(
|
|
'key' => $cart_id,
|
|
'product_id' => $product_id,
|
|
'variation_id' => $variation_id,
|
|
'variation' => $variations,
|
|
'quantity' => $quantity,
|
|
'data' => $product_data,
|
|
'data_hash' => wc_get_cart_item_data_hash( $product_data ),
|
|
)
|
|
),
|
|
$cart_id
|
|
);
|
|
}
|
|
|
|
do_action_ref_array( 'woocommerce_ordered_again', array( $order->get_id(), $order_items, &$cart ) );
|
|
|
|
$num_items_in_cart = count( $cart );
|
|
$num_items_in_original_order = count( $order_items );
|
|
$num_items_added = $num_items_in_cart - $inital_cart_size;
|
|
|
|
if ( $num_items_in_original_order > $num_items_added ) {
|
|
wc_add_notice(
|
|
sprintf(
|
|
/* translators: %d item count */
|
|
_n(
|
|
'%d item from your previous order is currently unavailable and could not be added to your cart.',
|
|
'%d items from your previous order are currently unavailable and could not be added to your cart.',
|
|
$num_items_in_original_order - $num_items_added,
|
|
'woocommerce'
|
|
),
|
|
$num_items_in_original_order - $num_items_added
|
|
),
|
|
'error'
|
|
);
|
|
}
|
|
|
|
if ( 0 < $num_items_added ) {
|
|
wc_add_notice( __( 'The cart has been filled with the items from your previous order.', 'woocommerce' ) );
|
|
}
|
|
|
|
return $cart;
|
|
}
|
|
}
|