WooCommerce二次开发：购物车对象使用及方法功能概述

terry 2年前 (2023-09-24) 阅读数 61 #后端开发

在WooCommerce二次开发过程中，经常需要更改购物车，有时甚至需要重写购物车页面，所以需要集成WooCommerce购物吧汽车提供的接口方法。这篇文章简单记录一下我在最近的一些项目中使用到的方法。

首先，在调用购物车方法之前，先检查当前页面环境是否可供购物车对象使用：

if ( is_null( WC()->cart ) ) {
wc_load_cart();
}
WC()->cart->get_cart();

常用条件函数，返回true/false

//检查购物车是否有商品
WC()->cart->is_empty();
//检查购物车是否需要付费，如果费用为0则返回false
WC()->cart->needs_payment();
//检查购物车中是否已经记录收货地址
WC()->cart->show_shipping();
//检查是不是需要寄送（用于计算运费的情况）
WC()->cart->needs_shipping();
//检查是不是有折扣，如果后台减了价格，这里会返回true
WC()->cart->has_discount();

获取数据

/* Author: Brain - blog.brain1981.com */
//返回购物车商品总数
WC()->cart->get_cart_contents_count();
//返回购物车小计
WC()->cart->get_cart_subtotal();
//返回总运费
WC()->cart->get_shipping_total();
//返回使用的优惠券，返回数组，内容包含优惠券对象和优惠码
WC()->cart->get_coupons();
//返回使用的优惠券，返回数组，内容仅包含优惠码
WC()->cart->get_applied_coupons();
返回指定优惠码在当前购物车中获得的折扣金额
WC()->cart->get_coupon_discount_amount( 'coupon_code' );
//返回总折扣金额，这俩其实等于同一个方法
WC()->cart->get_discount_total();
WC()->cart->get_cart_discount_total();
//返回购物车总金额，包含了折扣和运费
WC()->cart->get_total();
WC()->cart->tota;

获取用户的地址信息

/* Author: Brain - blog.brain1981.com */
//获取用户对象
WC()->cart->get_customer();
//获取用户的地址信息
WC()->cart->get_customer()->get_billing_first_name();
WC()->cart->get_customer()->get_billing_last_name();
WC()->cart->get_customer()->get_billing_company();
WC()->cart->get_customer()->get_billing_email();
WC()->cart->get_customer()->get_billing_phone();
WC()->cart->get_customer()->get_billing_country();
WC()->cart->get_customer()->get_billing_state();
WC()->cart->get_customer()->get_billing_postcode();
WC()->cart->get_customer()->get_billing_city();
WC()->cart->get_customer()->get_billing_address();
WC()->cart->get_customer()->get_billing_address_2();
WC()->cart->get_customer()->get_shipping_first_name();
WC()->cart->get_customer()->get_shipping_last_name();
WC()->cart->get_customer()->get_shipping_company();
WC()->cart->get_customer()->get_shipping_country();
WC()->cart->get_customer()->get_shipping_state();
WC()->cart->get_customer()->get_shipping_postcode();
WC()->cart->get_customer()->get_shipping_city();
WC()->cart->get_customer()->get_shipping_address();
WC()->cart->get_customer()->get_shipping_address_2();

常用方法

/* Author: Brain - blog.brain1981.com */
//添加指定的产品到购物车，如果是添加普通产品只需要$product_id和$quantity即可，添加可变产品比较复杂，会另外写博客介绍
WC()->cart->add_to_cart( $product_id, $quantity, $variation_id, $variation);
//修改购物车中商品的数量
WC()->cart->set_quantity( $item_key, $quantity );
//删除购物车中的商品
WC()->cart->remove_cart_item( $item_key );
//使用优惠券，参数就是优惠码
WC()->cart->apply_coupon( $coupon_code );
//删除优惠券，参数也是优惠码
WC()->cart->remove_coupon( $coupon_code );
//删除所有的优惠券
WC()->cart->remove_coupons();
//重新计算购物车价格
WC()->cart->calculate_totals();

add_to_cart、set_quantity和remove_cart_item方法中有一些需要注意的地方。执行这些添加或删除商品的方法后，购物车会自动调用calculate_totals来计算价格。但是优惠券的apply_coupon和remove_coupon方法执行完后，还需要自己执行calculate_totals来计算价格。

另外，set_quantity和remove_cart_item的$item_key参数是当前购物车中商品对应的键值。这些密钥以 JSON 格式存储，必须通过 WooCommerce 自己的封装方法来检索：
对于常规产品，他们已经知道 $product_id，$item_key 可以通过以下方法获取

$product_cart_id = WC()->cart->generate_cart_id( $product_id );
$item_key = WC()->cart->find_product_in_cart( $product_cart_id );

对于可变产品，知道 $variation_id通过遍历的方法可以得到

/* Author: Brain - blog.brain1981.com */
foreach ( WC()->cart->get_cart() as $item_key => $item ) {
	// If the targeted variation id is in cart
	if ( $item['variation_id'] == $variation_id ) {
		$item_key ... 
		break;
	}
}

通过上面总结的常用方法组合，我们就可以大致开发出自己的购物车程序了，我们先列出一个常用的列出购物车物品的函数：

/* Author: Brain - blog.brain1981.com */
function brain1981_rest_wc_cart_list($request = null) {
	if ( is_null( WC()->cart ) ) {
		wc_load_cart();
	}
	WC()->cart->get_cart();
	$resaults = [];
	if( WC()->cart->is_empty() ){//如果没有物品则直接返回
		return $resaults;
	}
	foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
		$productID = $cart_item['product_id'];
		$variationID = $cart_item['variation_id'];
 
		if($variationID == 0){ //普通产品
			$thumbnailID = get_post_meta( $productID, '_thumbnail_id', true);
			$attachment = wp_get_attachment_image_src($thumbnailID, 'woocommerce_thumbnail' );
			$product = wc_get_product($productID);
			$stock = $product->get_stock_quantity();
		} else { //可变产品
			$variation = new WC_Product_Variation( $variationID );
			$image_id = $variation->get_image_id();
			$attachment = wp_get_attachment_image_src($image_id, 'woocommerce_thumbnail' );
			$stock = $variation->get_stock_quantity();
		}
		if($attachment){
			$image = $attachment[0];
		} else {
			$image = get_template_directory_uri()."/images/logo.png";
		}
 
		$product_name = get_the_title($cart_item['product_id']);
 
		//整理影响变量的属性字段
		$attr_arr = [];
		if($variationID){
			$variation = wc_get_product($variationID);
			foreach( $cart_item['variation'] as $key => $value ){
				$tax_slug = str_replace('attribute_','', $key);
				$tax = get_taxonomy( $tax_slug );
				if($tax){
					$tax_name = $tax->labels->name; //exp "name": "产品 尺码",
				}else{
					$tax_name = urldecode($tax_slug);
				}
				$tax_name = str_replace('产品 ','', $tax_name);
 
				$term = get_term_by('slug', $value, $tax_slug);
				if($term){
					$term_name = $term->name;
				}else{
					$term_name = $value;
				}
 
				$attr = array(
					'name'=> $tax_name,
					'value' => $term_name
				);
				array_push( $attr_arr, $attr);
			}
		}
 
		$api_item = array(
			'product_image' => $image,
			'product_name' => $product_name,
			'product_id'   => $productID,
			'variation_id' => $variationID,
			'quantity'     => $cart_item['quantity'],
			'attributes'   => $attr_arr,
			'item_taxes'   => $cart_item['line_tax_data'],
			'subtotal_tax' => $cart_item['line_subtotal_tax'],
			'total_tax'    => $cart_item['line_tax'],
			'subtotal'     => $cart_item['line_subtotal'],
			'total'        => $cart_item['line_total'],
			'stock'        => $stock
		);
 
		array_push( $resaults, $api_item);
	}
	return $resaults;
}

主要参考：WooCommerce官方文档页面