Cart implements Registerable, Service
This class handles the bulk add-to-cart.
Tags
Interfaces, Classes and Traits
- Registerable
- Service
Table of Contents
- add_cart_notice() : mixed
- add_to_cart() : mixed
- add_to_cart_multi() : array<string|int, mixed>
- Add multiple products to the cart in a single step.
- add_to_cart_validation() : mixed
- get_product_variation_title() : mixed
- process_multi_cart() : mixed
- register() : mixed
- restore_variation_names() : mixed
- variation_stock_error_message() : string
- Generates a customized stock error message for product variations when adding to the cart.
- get_parent_title() : mixed
Methods
add_cart_notice()
public
add_cart_notice(mixed $added_to_cart[, mixed $show_qty = false ]) : mixed
Parameters
- $added_to_cart : mixed
- $show_qty : mixed = false
Return values
mixed —add_to_cart()
public
add_to_cart(mixed $product_id[, mixed $quantity = 1 ][, mixed $variation_id = false ][, mixed $variations = [] ]) : mixed
Parameters
- $product_id : mixed
- $quantity : mixed = 1
- $variation_id : mixed = false
- $variations : mixed = []
Return values
mixed —add_to_cart_multi()
Add multiple products to the cart in a single step.
public
add_to_cart_multi(array<string|int, mixed> $variations) : array<string|int, mixed>
Parameters
- $variations : array<string|int, mixed>
-
- An array of variations (including quantities and variation data) to add to the cart
Return values
array<string|int, mixed> —An array of product IDs => quantity added
add_to_cart_validation()
public
add_to_cart_validation(mixed $validated, mixed $product_id, mixed $qty) : mixed
Parameters
- $validated : mixed
- $product_id : mixed
- $qty : mixed
Return values
mixed —get_product_variation_title()
public
get_product_variation_title(mixed $product_variation_title, mixed $product, mixed $title_base, mixed $title_suffix) : mixed
Parameters
- $product_variation_title : mixed
- $product : mixed
- $title_base : mixed
- $title_suffix : mixed
Return values
mixed —process_multi_cart()
public
process_multi_cart() : mixed
Return values
mixed —register()
public
register() : mixed
Return values
mixed —restore_variation_names()
public
restore_variation_names(mixed $variation_ids) : mixed
Parameters
- $variation_ids : mixed
Return values
mixed —variation_stock_error_message()
Generates a customized stock error message for product variations when adding to the cart.
public
variation_stock_error_message(string $message, WC_Product $product, int $stock_quantity) : string
This method checks if the product is a variation and, if so, formats a message indicating the stock quantity and the amount already in the cart.
Parameters
- $message : string
-
The original error message.
- $product : WC_Product
-
The product object.
- $stock_quantity : int
-
The available stock quantity for the product.
Return values
string —The formatted error message.
get_parent_title()
private
get_parent_title(mixed $variation_ids) : mixed
Parameters
- $variation_ids : mixed