WooCommerce Code Reference

WC_Shipping_Legacy_Local_Pickup extends WC_Shipping_Method

Local Pickup Shipping Method.

This class is here for backwards compatibility for methods existing before zones existed.

Tags
deprecated
2.6.0
version
2.3.0

Table of Contents

$availability  : string
Availability - legacy. Used for method Availability.
$countries  : array
Availability countries - legacy. Used for method Availability.
$enabled  : string
Yes or no based on whether the method is enabled.
$errors  : array
Validation errors.
$fee  : string
Fee for the method (if applicable).
$form_fields  : array
Form option fields.
$id  : string
ID of the class extending the settings API. Used in option names.
$instance_form_fields  : array
Instance form fields.
$instance_id  : int
Instance ID if used.
$instance_settings  : array
Instance settings.
$method_description  : string
Method description.
$method_title  : string
Method title.
$minimum_fee  : string
Minimum fee for the method (if applicable).
$plugin_id  : string
The plugin ID. Used for option names.
$rates  : array
This is an array of rates - methods must populate this array to register shipping costs.
$settings  : array
Setting values.
$supports  : array
Features this method supports. Possible features used by core: - shipping-zones Shipping zone functionality + instances - instance-settings Instance settings screens.
$tax_status  : string
If 'taxable' tax will be charged for this method (if applicable).
$title  : string
Shipping method title for the frontend.
$data  : array
The posted settings data. When empty, $_POST data will be used.
__construct()  : mixed
Constructor.
add_error()  : mixed
Add an error message for display in admin on save.
add_rate()  : mixed
Add a shipping rate. If taxes are not set they will be calculated based on cost.
admin_options()  : mixed
Output the admin options table.
calculate_shipping()  : mixed
Calculate shipping.
clean()  : string
Clean function.
display_errors()  : mixed
Display admin error messages.
format_settings()  : array
Format settings if needed.
generate_checkbox_html()  : string
Generate Checkbox HTML.
generate_color_html()  : string
Generate Color Picker Input HTML.
generate_decimal_html()  : string
Generate Decimal Input HTML.
generate_multiselect_html()  : string
Generate Multiselect HTML.
generate_password_html()  : string
Generate Password Input HTML.
generate_price_html()  : string
Generate Price Input HTML.
generate_select_html()  : string
Generate Select HTML.
generate_settings_html()  : string
Generate Settings HTML.
generate_text_html()  : string
Generate Text Input HTML.
generate_textarea_html()  : string
Generate Textarea HTML.
generate_title_html()  : string
Generate Title HTML.
get_admin_options_html()  : string
Return admin options as a html string.
get_custom_attribute_html()  : string
Get custom attributes.
get_description_html()  : string
Get HTML for descriptions.
get_errors()  : mixed
Get admin error messages.
get_fee()  : float
Get fee to add to shipping cost.
get_field_default()  : string
Get a fields default value. Defaults to "" if not set.
get_field_key()  : string
Prefix key for settings.
get_field_type()  : string
Get a fields type. Defaults to "text" if not set.
get_field_value()  : string
Get a field's posted and validated value.
get_form_fields()  : array
Get the form fields after they are initialized.
get_instance_form_fields()  : array
Get settings fields for instances of this shipping method (within zones).
get_instance_id()  : int
Return the shipping method instance ID.
get_instance_option()  : mixed
Gets an option from the settings API, using defaults if necessary to prevent undefined notices.
get_instance_option_key()  : string
Return the name of the option in the WP DB.
get_method_description()  : string
Return the shipping method description.
get_method_title()  : string
Return the shipping method title.
get_option()  : string
Get option from DB.
get_option_key()  : string
Return the name of the option in the WP DB.
get_post_data()  : array
Returns the POSTed data, to be used to save the settings.
get_rate_id()  : string
Returns a rate ID based on this methods ID and instance, with an optional suffix if distinguishing between multiple rates.
get_rates_for_package()  : array
Return calculated rates for a package.
get_title()  : string
Return the shipping title which is user set.
get_tooltip_html()  : string
Get HTML for tooltips.
get_valid_postcodes()  : array
Get postcodes for this method.
has_settings()  : bool
Does this method have a settings page?
init()  : mixed
Init function.
init_form_fields()  : mixed
Initialize form fields.
init_instance_settings()  : mixed
Initialise Settings for instances.
init_settings()  : mixed
Initialise Settings.
is_available()  : bool
See if the method is available.
is_enabled()  : bool
Whether or not this method is enabled in settings.
is_taxable()  : bool
Whether or not we need to calculate tax on top of the shipping rate.
is_valid_postcode()  : bool
See if a given postcode matches valid postcodes.
process_admin_options()  : bool
Process and redirect if disabled.
set_post_data()  : mixed
Sets the POSTed data. This method can be used to set specific data, instead of taking it from the $_POST array.
supports()  : bool
Check if a shipping method supports a given feature.
update_option()  : bool
Update a single option.
validate_checkbox_field()  : string
Validate Checkbox Field.
validate_decimal_field()  : string
Validate Decimal Field.
validate_multiselect_field()  : string|array
Validate Multiselect Field.
validate_password_field()  : string
Validate Password Field. No input sanitization is used to avoid corrupting passwords.
validate_price_field()  : string
Validate Price Field.
validate_select_field()  : string
Validate Select Field.
validate_settings_fields()  : mixed
Validate the data on the "Settings" form.
validate_text_field()  : string
Validate Text Field.
validate_textarea_field()  : string
Validate Textarea Field.
get_taxes_per_item()  : array
Calc taxes per item being shipping in costs array.
set_defaults()  : array
Set default required properties for each field.

Properties

$supports

Features this method supports. Possible features used by core: - shipping-zones Shipping zone functionality + instances - instance-settings Instance settings screens.

public array $supports = array('settings')
  • settings Non-instance settings screens. Enabled by default for BW compatibility with methods before instances existed.
  • instance-settings-modal Allows the instance settings to be loaded within a modal in the zones UI.

Methods

add_rate()

Add a shipping rate. If taxes are not set they will be calculated based on cost.

public add_rate([array $args = array() ]) : mixed
Parameters
$args : array = array()

Arguments (default: array()).

Return values
mixed

format_settings()

Format settings if needed.

public format_settings(array $value) : array
Parameters
$value : array

Value to format.

Tags
deprecated
2.6.0

Unused.

Return values
array

generate_checkbox_html()

Generate Checkbox HTML.

public generate_checkbox_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_color_html()

Generate Color Picker Input HTML.

public generate_color_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_decimal_html()

Generate Decimal Input HTML.

public generate_decimal_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_multiselect_html()

Generate Multiselect HTML.

public generate_multiselect_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_password_html()

Generate Password Input HTML.

public generate_password_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_price_html()

Generate Price Input HTML.

public generate_price_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_select_html()

Generate Select HTML.

public generate_select_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_settings_html()

Generate Settings HTML.

public generate_settings_html([array $form_fields = array() ][, bool $echo = true ]) : string

Generate the HTML for the fields on the "settings" screen.

Parameters
$form_fields : array = array()

(default: array()) Array of form fields.

$echo : bool = true

Echo or return.

Tags
since
1.0.0
uses
method_exists()
Return values
stringthe html for the settings

generate_text_html()

Generate Text Input HTML.

public generate_text_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_textarea_html()

Generate Textarea HTML.

public generate_textarea_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

generate_title_html()

Generate Title HTML.

public generate_title_html(string $key, array $data) : string
Parameters
$key : string

Field key.

$data : array

Field data.

Tags
since
1.0.0
Return values
string

get_field_default()

Get a fields default value. Defaults to "" if not set.

public get_field_default(array $field) : string
Parameters
$field : array

Field key.

Return values
string

get_field_value()

Get a field's posted and validated value.

public get_field_value(string $key, array $field[, array $post_data = array() ]) : string
Parameters
$key : string

Field key.

$field : array

Field array.

$post_data : array = array()

Posted data.

Return values
string

get_instance_form_fields()

Get settings fields for instances of this shipping method (within zones).

public get_instance_form_fields() : array

Should be overridden by shipping methods to add options.

Tags
since
2.6.0
Return values
array

get_instance_option()

Gets an option from the settings API, using defaults if necessary to prevent undefined notices.

public get_instance_option(string $key[, mixed $empty_value = null ]) : mixed
Parameters
$key : string

Key.

$empty_value : mixed = null

Empty value.

Return values
mixedThe value specified for the option or a default value for the option.

get_option()

Get option from DB.

public get_option(string $key[, mixed $empty_value = null ]) : string

Gets an option from the settings API, using defaults if necessary to prevent undefined notices.

Parameters
$key : string

Option key.

$empty_value : mixed = null

Value when empty.

Return values
stringThe value specified for the option or a default value for the option.

get_rate_id()

Returns a rate ID based on this methods ID and instance, with an optional suffix if distinguishing between multiple rates.

public get_rate_id([string $suffix = '' ]) : string
Parameters
$suffix : string = ''

Suffix.

Tags
since
2.6.0
Return values
string

get_rates_for_package()

Return calculated rates for a package.

public get_rates_for_package(array $package) : array
Parameters
$package : array

Package array.

Tags
since
2.6.0
Return values
array

init_settings()

Initialise Settings.

public init_settings() : mixed

Store all settings in a single database entry and make sure the $settings array is either the default or the settings stored in the database.

Tags
since
1.0.0
uses

get_option(), add_option()

Return values
mixed

set_post_data()

Sets the POSTed data. This method can be used to set specific data, instead of taking it from the $_POST array.

public set_post_data([array $data = array() ]) : mixed
Parameters
$data : array = array()

Posted data.

Return values
mixed

supports()

Check if a shipping method supports a given feature.

public supports(string $feature) : bool

Methods should override this to declare support (or lack of support) for a feature.

Parameters
$feature : string

The name of a feature to test support for.

Return values
boolTrue if the shipping method supports the feature, false otherwise.

update_option()

Update a single option.

public update_option(string $key[, mixed $value = '' ]) : bool
Parameters
$key : string

Option key.

$value : mixed = ''

Value to set.

Tags
since
3.4.0
Return values
boolwas anything saved?

validate_checkbox_field()

Validate Checkbox Field.

public validate_checkbox_field(string $key, string $value) : string

If not set, return "no", otherwise return "yes".

Parameters
$key : string

Field key.

$value : string

Posted Value.

Return values
string

validate_decimal_field()

Validate Decimal Field.

public validate_decimal_field(string $key, string $value) : string

Make sure the data is escaped correctly, etc.

Parameters
$key : string

Field key.

$value : string

Posted Value.

Return values
string

validate_multiselect_field()

Validate Multiselect Field.

public validate_multiselect_field(string $key, string $value) : string|array
Parameters
$key : string

Field key.

$value : string

Posted Value.

Return values
string|array

validate_password_field()

Validate Password Field. No input sanitization is used to avoid corrupting passwords.

public validate_password_field(string $key, string $value) : string
Parameters
$key : string

Field key.

$value : string

Posted Value.

Return values
string

validate_price_field()

Validate Price Field.

public validate_price_field(string $key, string $value) : string

Make sure the data is escaped correctly, etc.

Parameters
$key : string

Field key.

$value : string

Posted Value.

Return values
string

validate_select_field()

Validate Select Field.

public validate_select_field(string $key, string $value) : string
Parameters
$key : string

Field key.

$value : string

Posted Value.

Return values
string

validate_settings_fields()

Validate the data on the "Settings" form.

public validate_settings_fields([array $form_fields = array() ]) : mixed
Parameters
$form_fields : array = array()

Array of fields.

Tags
deprecated
2.6.0

No longer used.

Return values
mixed

validate_text_field()

Validate Text Field.

public validate_text_field(string $key, string $value) : string

Make sure the data is escaped correctly, etc.

Parameters
$key : string

Field key.

$value : string

Posted Value.

Return values
string

validate_textarea_field()

Validate Textarea Field.

public validate_textarea_field(string $key, string $value) : string
Parameters
$key : string

Field key.

$value : string

Posted Value.

Return values
string

get_taxes_per_item()

Calc taxes per item being shipping in costs array.

protected get_taxes_per_item(array $costs) : array
Parameters
$costs : array

Costs.

Tags
since
2.6.0
Return values
arrayof taxes