PHP Class WC_Order_Item_Data_Store

Author: WooCommerce
Inheritance: implements WC_Order_Item_Data_Store_Interface
Show file Open project: woocommerce/woocommerce

Public Methods

Method Description
add_metadata ( mixed $item_id, mixed $meta_key, mixed $meta_value, boolean $unique = false ) : integer Add term meta.
add_order_item ( integer $order_id, $item ) : integer Add an order item to an order.
delete_metadata ( mixed $item_id, mixed $meta_key, string $meta_value = '', boolean $delete_all = false ) : boolean Delete term meta.
delete_order_item ( integer $item_id ) Delete an order item.
get_metadata ( mixed $item_id, mixed $key, boolean $single = true ) : mixed Get term meta.
update_metadata ( mixed $item_id, mixed $meta_key, mixed $meta_value, string $prev_value = '' ) : boolean Update term meta.
update_order_item ( integer $item_id, $item ) : boolean Update an order item.

Method Details

add_metadata() public method

Add term meta.
Since: 2.7.0
public add_metadata ( mixed $item_id, mixed $meta_key, mixed $meta_value, boolean $unique = false ) : integer
$item_id mixed
$meta_key mixed
$meta_value mixed
$unique boolean (default: false)
return integer New row ID or 0

add_order_item() public method

Add an order item to an order.
Since: 2.7.0
public add_order_item ( integer $order_id, $item ) : integer
$order_id integer
return integer Order Item ID

delete_metadata() public method

Delete term meta.
Since: 2.7.0
public delete_metadata ( mixed $item_id, mixed $meta_key, string $meta_value = '', boolean $delete_all = false ) : boolean
$item_id mixed
$meta_key mixed
$meta_value string (default: '')
$delete_all boolean (default: false)
return boolean

delete_order_item() public method

Delete an order item.
Since: 2.7.0
public delete_order_item ( integer $item_id )
$item_id integer

get_metadata() public method

Get term meta.
Since: 2.7.0
public get_metadata ( mixed $item_id, mixed $key, boolean $single = true ) : mixed
$item_id mixed
$key mixed
$single boolean (default: true)
return mixed

update_metadata() public method

Update term meta.
Since: 2.7.0
public update_metadata ( mixed $item_id, mixed $meta_key, mixed $meta_value, string $prev_value = '' ) : boolean
$item_id mixed
$meta_key mixed
$meta_value mixed
$prev_value string (default: '')
return boolean

update_order_item() public method

Update an order item.
Since: 2.7.0
public update_order_item ( integer $item_id, $item ) : boolean
$item_id integer
return boolean