WooCommerce Code Reference

WC_Shipping_Zone extends WC_Legacy_Shipping_Zone
in package

WC_Shipping_Zone class.

Table of Contents

$cache_group  : string
Stores meta in cache for future reads.
$changes  : array<string|int, mixed>
Core data changes for this object.
$data  : array<string|int, mixed>
Zone Data.
$data_store  : object
Contains a reference to the data store for this class.
$default_data  : array<string|int, mixed>
Set to _data on construct so we can track and reset data if needed.
$extra_data  : array<string|int, mixed>
Extra data for this object. Name value pairs (name + default value).
$id  : int|null
Zone ID
$legacy_datastore_props  : array<string|int, mixed>
List of properties that were earlier managed by data store. However, since DataStore is a not a stored entity in itself, they used to store data in metadata of the data object.
$meta_data  : array<string|int, mixed>
Stores additional meta data.
$object_read  : bool
This is false until the object is read from the DB.
$object_type  : string
This is the name of this object type.
__clone()  : mixed
When the object is cloned, make sure meta is duplicated correctly.
__construct()  : mixed
Constructor for zones.
__sleep()  : array<string|int, mixed>
Only store the object ID to avoid serializing the data object instance.
__toString()  : string
Change data to JSON format.
__wakeup()  : mixed
Re-run the constructor with the object ID.
add_location()  : mixed
Add location (state or postcode) to a zone.
add_meta_data()  : mixed
Add meta data.
add_shipping_method()  : int
Add a shipping method to this zone.
apply_changes()  : mixed
Merge changes with data and clear.
clear_locations()  : mixed
Clear all locations for this zone.
create()  : mixed
Create a zone.
delete()  : bool
Delete an object, set the ID to 0, and return result.
delete_meta_data()  : mixed
Delete meta data.
delete_meta_data_by_mid()  : mixed
Delete meta data.
delete_meta_data_value()  : mixed
Delete meta data with a matching value.
delete_shipping_method()  : true
Delete a shipping method from a zone.
generate_meta_cache_key()  : string
Generate cache key from id and group.
get_changes()  : array<string|int, mixed>
Return data changes only.
get_data()  : array<string|int, mixed>
Returns all data for this object.
get_data_keys()  : array<string|int, mixed>
Returns array of expected data keys for this object.
get_data_store()  : object
Get the data store.
get_extra_data_keys()  : array<string|int, mixed>
Returns all "extra" data keys for an object (for sub objects like product types).
get_formatted_location()  : string
Return a text string representing what this zone is for.
get_id()  : int
Returns the unique ID for this object.
get_meta()  : mixed
Get Meta Data by Key.
get_meta_cache_key()  : string
Helper method to compute meta cache key. Different from WP Meta cache key in that meta data cached using this key also contains meta_id column.
get_meta_data()  : array<string|int, mixed>
Get All Meta Data.
get_object_read()  : bool
Get object read property.
get_shipping_methods()  : array<string|int, mixed>
Get shipping methods linked to this zone.
get_zone_id()  : int|null
Get zone ID
get_zone_locations()  : array<string|int, mixed>
Get zone locations.
get_zone_name()  : string
Get zone name.
get_zone_order()  : int
Get zone order.
init_meta_data()  : mixed
Helper function to initialize metadata entries from filtered raw meta data.
is_valid_location_type()  : bool
Is passed location type valid?
meta_exists()  : bool
See if meta data exists, since get_meta always returns a '' or array().
prime_raw_meta_data_cache()  : mixed
Prime caches for raw meta data. This includes meta_id column as well, which is not included by default in WP meta data.
read()  : mixed
Read a shipping zone by ID.
read_meta_data()  : mixed
Read Meta Data from the database. Ignore any internal properties.
save()  : int
Save zone data to the database.
save_meta_data()  : mixed
Update Meta Data in the database.
set_defaults()  : mixed
Set all props to default values.
set_id()  : mixed
Set ID.
set_locations()  : mixed
Set locations.
set_meta_data()  : mixed
Set all meta data from array.
set_object_read()  : mixed
Set object read property.
set_props()  : bool|WP_Error
Set a collection of props in one go, collect any errors, and return the result.
set_zone_locations()  : mixed
Set zone locations.
set_zone_name()  : mixed
Set zone name.
set_zone_order()  : mixed
Set zone order. Value to set.
update()  : mixed
Update a zone.
update_meta_data()  : mixed
Update meta data by key or ID, if provided.
error()  : mixed
When invalid data is found, throw an exception unless reading from the DB.
filter_null_meta()  : bool
Filter null meta values from array.
generate_zone_name()  : string
Generate a zone name based on location.
get_hook_prefix()  : string
Prefix for action and filter hooks on data.
get_prop()  : mixed
Gets a prop for a getter method.
is_internal_meta_key()  : bool
Check if the key is an internal one.
maybe_read_meta_data()  : mixed
Read meta data if null.
set_date_prop()  : mixed
Sets a date prop whilst handling formatting and datetime objects.
set_prop()  : mixed
Sets a prop for a setter method.
location_is_continent()  : bool
Location type detection.
location_is_country()  : bool
Location type detection.
location_is_postcode()  : bool
Location type detection.
location_is_state()  : bool
Location type detection.

Properties

$data

Zone Data.

protected array<string|int, mixed> $data = array('zone_name' => '', 'zone_order' => 0, 'zone_locations' => array())

$default_data

Set to _data on construct so we can track and reset data if needed.

protected array<string|int, mixed> $default_data = array()
Tags
since
3.0.0

$extra_data

Extra data for this object. Name value pairs (name + default value).

protected array<string|int, mixed> $extra_data = array()

Used as a standard way for sub classes (like product types) to add additional information to an inherited class.

Tags
since
3.0.0

$legacy_datastore_props

List of properties that were earlier managed by data store. However, since DataStore is a not a stored entity in itself, they used to store data in metadata of the data object.

protected array<string|int, mixed> $legacy_datastore_props = array()

With custom tables, some of these are moved from metadata to their own columns, but existing code will still try to add them to metadata. This array is used to keep track of such properties.

Only reason to add a property here is that you are moving properties from DataStore instance to data object. If you are adding a new property, consider adding it to to $data array instead.

Methods

__construct()

Constructor for zones.

public __construct([int|object $zone = null ]) : mixed
Parameters
$zone : int|object = null

Zone ID to load from the DB or zone object.

Return values
mixed

__sleep()

Only store the object ID to avoid serializing the data object instance.

public __sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>

__wakeup()

Re-run the constructor with the object ID.

public __wakeup() : mixed

If the object no longer exists, remove the ID.

Return values
mixed

add_location()

Add location (state or postcode) to a zone.

public add_location(string $code, string $type) : mixed
Parameters
$code : string

Location code.

$type : string

state or postcode.

Return values
mixed

add_meta_data()

Add meta data.

public add_meta_data(string $key, string|array<string|int, mixed> $value[, bool $unique = false ]) : mixed
Parameters
$key : string

Meta key.

$value : string|array<string|int, mixed>

Meta value.

$unique : bool = false

Should this be a unique key?.

Tags
since
2.6.0
Return values
mixed

add_shipping_method()

Add a shipping method to this zone.

public add_shipping_method(string $type) : int
Parameters
$type : string

shipping method type.

Return values
intnew instance_id, 0 on failure

clear_locations()

Clear all locations for this zone.

public clear_locations([array<string|int, mixed>|string $types = array('postcode', 'state', 'country', 'continent') ]) : mixed
Parameters
$types : array<string|int, mixed>|string = array('postcode', 'state', 'country', 'continent')

of location to clear.

Return values
mixed

delete()

Delete an object, set the ID to 0, and return result.

public delete([bool $force_delete = false ]) : bool
Parameters
$force_delete : bool = false

Should the date be deleted permanently.

Tags
since
2.6.0
Return values
boolresult

delete_meta_data()

Delete meta data.

public delete_meta_data(string $key) : mixed
Parameters
$key : string

Meta key.

Tags
since
2.6.0
Return values
mixed

delete_meta_data_by_mid()

Delete meta data.

public delete_meta_data_by_mid(int $mid) : mixed
Parameters
$mid : int

Meta ID.

Tags
since
2.6.0
Return values
mixed

delete_meta_data_value()

Delete meta data with a matching value.

public delete_meta_data_value(string $key, mixed $value) : mixed
Parameters
$key : string

Meta key.

$value : mixed

Meta value. Entries will only be removed that match the value.

Tags
since
7.7.0
Return values
mixed

delete_shipping_method()

Delete a shipping method from a zone.

public delete_shipping_method(int $instance_id) : true
Parameters
$instance_id : int

Shipping method instance ID.

Return values
trueon success, false on failure

generate_meta_cache_key()

Generate cache key from id and group.

public static generate_meta_cache_key(int|string $id, string $cache_group) : string
Parameters
$id : int|string

Object ID.

$cache_group : string

Group name use to store cache. Whole group cache can be invalidated in one go.

Tags
since
4.7.0
Return values
stringMeta cache key.

get_changes()

Return data changes only.

public get_changes() : array<string|int, mixed>
Tags
since
3.0.0
Return values
array<string|int, mixed>

get_data()

Returns all data for this object.

public get_data() : array<string|int, mixed>
Tags
since
2.6.0
Return values
array<string|int, mixed>

get_data_keys()

Returns array of expected data keys for this object.

public get_data_keys() : array<string|int, mixed>
Tags
since
3.0.0
Return values
array<string|int, mixed>

get_extra_data_keys()

Returns all "extra" data keys for an object (for sub objects like product types).

public get_extra_data_keys() : array<string|int, mixed>
Tags
since
3.0.0
Return values
array<string|int, mixed>

get_formatted_location()

Return a text string representing what this zone is for.

public get_formatted_location([int $max = 10 ][, string $context = 'view' ]) : string
Parameters
$max : int = 10

Max locations to return.

$context : string = 'view'

View or edit context.

Return values
string

get_meta()

Get Meta Data by Key.

public get_meta([string $key = '' ][, bool $single = true ][, string $context = 'view' ]) : mixed
Parameters
$key : string = ''

Meta Key.

$single : bool = true

return first found meta with key, or all with $key.

$context : string = 'view'

What the value is for. Valid values are view and edit.

Tags
since
2.6.0
Return values
mixed

get_meta_cache_key()

Helper method to compute meta cache key. Different from WP Meta cache key in that meta data cached using this key also contains meta_id column.

public get_meta_cache_key() : string
Tags
since
4.7.0
Return values
string

get_meta_data()

Get All Meta Data.

public get_meta_data() : array<string|int, mixed>
Tags
since
2.6.0
Return values
array<string|int, mixed>of objects.

get_shipping_methods()

Get shipping methods linked to this zone.

public get_shipping_methods([bool $enabled_only = false ][, string $context = 'admin' ]) : array<string|int, mixed>
Parameters
$enabled_only : bool = false

Only return enabled methods.

$context : string = 'admin'

Getting shipping methods for what context. Valid values, admin, json.

Return values
array<string|int, mixed>of objects

get_zone_locations()

Get zone locations.

public get_zone_locations([string $context = 'view' ]) : array<string|int, mixed>
Parameters
$context : string = 'view'

View or edit context.

Return values
array<string|int, mixed>of zone objects

get_zone_name()

Get zone name.

public get_zone_name([string $context = 'view' ]) : string
Parameters
$context : string = 'view'

View or edit context.

Return values
string

get_zone_order()

Get zone order.

public get_zone_order([string $context = 'view' ]) : int
Parameters
$context : string = 'view'

View or edit context.

Return values
int

init_meta_data()

Helper function to initialize metadata entries from filtered raw meta data.

public init_meta_data([array<string|int, mixed> $filtered_meta_data = array() ]) : mixed
Parameters
$filtered_meta_data : array<string|int, mixed> = array()

Filtered metadata fetched from DB.

Return values
mixed

is_valid_location_type()

Is passed location type valid?

public is_valid_location_type(string $type) : bool
Parameters
$type : string

Type to check.

Return values
bool

meta_exists()

See if meta data exists, since get_meta always returns a '' or array().

public meta_exists([string $key = '' ]) : bool
Parameters
$key : string = ''

Meta Key.

Tags
since
3.0.0
Return values
bool

prime_raw_meta_data_cache()

Prime caches for raw meta data. This includes meta_id column as well, which is not included by default in WP meta data.

public static prime_raw_meta_data_cache(array<string|int, mixed> $raw_meta_data_collection, string $cache_group) : mixed
Parameters
$raw_meta_data_collection : array<string|int, mixed>

Array of objects of { object_id => array( meta_row_1, meta_row_2, ... }.

$cache_group : string

Name of cache group.

Tags
since
4.7.0
Return values
mixed

read_meta_data()

Read Meta Data from the database. Ignore any internal properties.

public read_meta_data([bool $force_read = false ]) : mixed

Uses it's own caches because get_metadata does not provide meta_ids.

Parameters
$force_read : bool = false

True to force a new DB read (and update cache).

Tags
since
2.6.0
Return values
mixed

set_locations()

Set locations.

public set_locations([array<string|int, mixed> $locations = array() ]) : mixed
Parameters
$locations : array<string|int, mixed> = array()

Array of locations.

Return values
mixed

set_meta_data()

Set all meta data from array.

public set_meta_data(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

Key/Value pairs.

Tags
since
2.6.0
Return values
mixed

set_object_read()

Set object read property.

public set_object_read([bool $read = true ]) : mixed
Parameters
$read : bool = true

Should read?.

Tags
since
3.0.0
Return values
mixed

set_props()

Set a collection of props in one go, collect any errors, and return the result.

public set_props(array<string|int, mixed> $props[, string $context = 'set' ]) : bool|WP_Error

Only sets using public methods.

Parameters
$props : array<string|int, mixed>

Key value pairs to set. Key is the prop and should map to a setter function name.

$context : string = 'set'

In what context to run this.

Tags
since
3.0.0
Return values
bool|WP_Error

set_zone_locations()

Set zone locations.

public set_zone_locations(array<string|int, mixed> $locations) : mixed
Parameters
$locations : array<string|int, mixed>

Value to set.

Tags
since
3.0.0
Return values
mixed

set_zone_name()

Set zone name.

public set_zone_name(string $set) : mixed
Parameters
$set : string

Value to set.

Return values
mixed

set_zone_order()

Set zone order. Value to set.

public set_zone_order(int $set) : mixed
Parameters
$set : int

Value to set.

Return values
mixed

update_meta_data()

Update meta data by key or ID, if provided.

public update_meta_data(string $key, string|array<string|int, mixed> $value, int $meta_id) : mixed
Parameters
$key : string

Meta key.

$value : string|array<string|int, mixed>

Meta value.

$meta_id : int

Meta ID.

Tags
since
2.6.0
Return values
mixed

error()

When invalid data is found, throw an exception unless reading from the DB.

protected error(string $code, string $message[, int $http_status_code = 400 ][, array<string|int, mixed> $data = array() ]) : mixed
Parameters
$code : string

Error code.

$message : string

Error message.

$http_status_code : int = 400

HTTP status code.

$data : array<string|int, mixed> = array()

Extra error data.

Tags
throws
WC_Data_Exception

Data Exception.

since
3.0.0
Return values
mixed

filter_null_meta()

Filter null meta values from array.

protected filter_null_meta(mixed $meta) : bool
Parameters
$meta : mixed

Meta value to check.

Tags
since
3.0.0
Return values
bool

get_prop()

Gets a prop for a getter method.

protected get_prop(string $prop[, string $context = 'view' ]) : mixed

Gets the value from either current pending changes, or the data itself. Context controls what happens to the value before it's returned.

Parameters
$prop : string

Name of prop to get.

$context : string = 'view'

What the value is for. Valid values are view and edit.

Tags
since
3.0.0
Return values
mixed

is_internal_meta_key()

Check if the key is an internal one.

protected is_internal_meta_key(string $key) : bool
Parameters
$key : string

Key to check.

Tags
since
3.2.0
Return values
booltrue if it's an internal key, false otherwise

set_date_prop()

Sets a date prop whilst handling formatting and datetime objects.

protected set_date_prop(string $prop, string|int $value) : mixed
Parameters
$prop : string

Name of prop to set.

$value : string|int

Value of the prop.

Tags
since
3.0.0
Return values
mixed

set_prop()

Sets a prop for a setter method.

protected set_prop(string $prop, mixed $value) : mixed

This stores changes in a special array so we can track what needs saving the the DB later.

Parameters
$prop : string

Name of prop to set.

$value : mixed

Value of the prop.

Tags
since
3.0.0
Return values
mixed

location_is_continent()

Location type detection.

private location_is_continent(object $location) : bool
Parameters
$location : object

Location to check.

Return values
bool

location_is_country()

Location type detection.

private location_is_country(object $location) : bool
Parameters
$location : object

Location to check.

Return values
bool

location_is_postcode()

Location type detection.

private location_is_postcode(object $location) : bool
Parameters
$location : object

Location to check.

Return values
bool

location_is_state()

Location type detection.

private location_is_state(object $location) : bool
Parameters
$location : object

Location to check.

Return values
bool