WC_Shipping_Rate
in package
implements
JsonSerializable
Shipping rate class.
Interfaces, Classes and Traits
- JsonSerializable
Table of Contents
- $data : array<string|int, mixed>
- Stores data for this rate.
- $meta_data : array<string|int, mixed>
- Stores meta data for this rate.
- __construct() : mixed
- Constructor.
- __get() : mixed
- Magic methods to support direct access to props.
- __isset() : bool
- Magic method to support direct access to data prop.
- __set() : mixed
- Magic methods to support direct access to props.
- add_meta_data() : mixed
- Add some meta data for this rate.
- get_cost() : string
- Get rate cost.
- get_delivery_time() : string
- Get rate delivery time.
- get_description() : string
- Get rate description.
- get_id() : string
- Get ID for the rate. This is usually a combination of the method and instance IDs.
- get_instance_id() : int
- Get instance ID the rate belongs to.
- get_label() : string
- Get rate label.
- get_meta_data() : array<string|int, mixed>
- Get all meta data for this rate.
- get_method_id() : string
- Get shipping method ID the rate belongs to.
- get_shipping_tax() : float
- Get shipping tax.
- get_tax_status() : string
- Get tax status.
- get_taxes() : array<string|int, mixed>
- Get rate taxes.
- jsonSerialize() : object|array<string|int, mixed>
- When converted to JSON.
- set_cost() : mixed
- Set rate cost.
- set_delivery_time() : mixed
- Set rate delivery time.
- set_description() : mixed
- Set rate description.
- set_id() : mixed
- Set ID for the rate. This is usually a combination of the method and instance IDs.
- set_instance_id() : mixed
- Set instance ID the rate belongs to.
- set_label() : mixed
- Set rate label.
- set_method_id() : mixed
- Set shipping method ID the rate belongs to.
- set_tax_status() : mixed
- Set tax status.
- set_taxes() : mixed
- Set rate taxes.
Properties
$data
Stores data for this rate.
protected
array<string|int, mixed>
$data
= array('id' => '', 'method_id' => '', 'instance_id' => 0, 'label' => '', 'cost' => 0, 'taxes' => array(), 'tax_status' => AutomatticWooCommerceEnumsProductTaxStatus::TAXABLE, 'description' => '', 'delivery_time' => '')
Tags
$meta_data
Stores meta data for this rate.
protected
array<string|int, mixed>
$meta_data
= array()
Methods
__construct()
Constructor.
public
__construct([string $id = '' ][, string $label = '' ], int $cost[, array<string|int, mixed> $taxes = array() ][, string $method_id = '' ], int $instance_id[, string $tax_status = ProductTaxStatus::TAXABLE ][, string $description = '' ][, string $delivery_time = '' ]) : mixed
Parameters
- $id : string = ''
-
Shipping rate ID.
- $label : string = ''
-
Shipping rate label.
- $cost : int
-
Cost.
- $taxes : array<string|int, mixed> = array()
-
Taxes applied to shipping rate.
- $method_id : string = ''
-
Shipping method ID.
- $instance_id : int
-
Shipping instance ID.
- $tax_status : string = ProductTaxStatus::TAXABLE
-
Tax status.
- $description : string = ''
-
Shipping rate description.
- $delivery_time : string = ''
-
Shipping rate delivery time.
Return values
mixed —__get()
Magic methods to support direct access to props.
public
__get(string $key) : mixed
Parameters
- $key : string
-
Key.
Return values
mixed —__isset()
Magic method to support direct access to data prop.
public
__isset(string $key) : bool
Parameters
- $key : string
-
Key.
Return values
bool —__set()
Magic methods to support direct access to props.
public
__set(string $key, mixed $value) : mixed
Parameters
- $key : string
-
Key.
- $value : mixed
-
Value.
Tags
Return values
mixed —add_meta_data()
Add some meta data for this rate.
public
add_meta_data(string $key, string $value) : mixed
Parameters
- $key : string
-
Key.
- $value : string
-
Value.
Tags
Return values
mixed —get_cost()
Get rate cost.
public
get_cost() : string
Tags
Return values
string —get_delivery_time()
Get rate delivery time.
public
get_delivery_time() : string
Tags
Return values
string —get_description()
Get rate description.
public
get_description() : string
Tags
Return values
string —get_id()
Get ID for the rate. This is usually a combination of the method and instance IDs.
public
get_id() : string
Tags
Return values
string —get_instance_id()
Get instance ID the rate belongs to.
public
get_instance_id() : int
Tags
Return values
int —get_label()
Get rate label.
public
get_label() : string
Return values
string —get_meta_data()
Get all meta data for this rate.
public
get_meta_data() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_method_id()
Get shipping method ID the rate belongs to.
public
get_method_id() : string
Tags
Return values
string —get_shipping_tax()
Get shipping tax.
public
get_shipping_tax() : float
Return values
float —get_tax_status()
Get tax status.
public
get_tax_status() : string
Return values
string —get_taxes()
Get rate taxes.
public
get_taxes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —jsonSerialize()
When converted to JSON.
public
jsonSerialize() : object|array<string|int, mixed>
Return values
object|array<string|int, mixed> —set_cost()
Set rate cost.
public
set_cost(string $cost) : mixed
Parameters
- $cost : string
-
Shipping rate cost.
Tags
Return values
mixed —set_delivery_time()
Set rate delivery time.
public
set_delivery_time(string $delivery_time) : mixed
Parameters
- $delivery_time : string
-
Shipping rate delivery time.
Tags
Return values
mixed —set_description()
Set rate description.
public
set_description(string $description) : mixed
Parameters
- $description : string
-
Shipping rate description.
Tags
Return values
mixed —set_id()
Set ID for the rate. This is usually a combination of the method and instance IDs.
public
set_id(string $id) : mixed
Parameters
- $id : string
-
Shipping rate ID.
Tags
Return values
mixed —set_instance_id()
Set instance ID the rate belongs to.
public
set_instance_id(int $instance_id) : mixed
Parameters
- $instance_id : int
-
Instance ID.
Tags
Return values
mixed —set_label()
Set rate label.
public
set_label(string $label) : mixed
Parameters
- $label : string
-
Shipping rate label.
Tags
Return values
mixed —set_method_id()
Set shipping method ID the rate belongs to.
public
set_method_id(string $method_id) : mixed
Parameters
- $method_id : string
-
Shipping method ID.
Tags
Return values
mixed —set_tax_status()
Set tax status.
public
set_tax_status(string $value) : mixed
Parameters
- $value : string
-
Tax status.
Tags
Return values
mixed —set_taxes()
Set rate taxes.
public
set_taxes(array<string|int, mixed> $taxes) : mixed
Parameters
- $taxes : array<string|int, mixed>
-
List of taxes applied to shipping rate.