WooCommerce Code Reference

WC_Integration_MaxMind_Geolocation extends WC_Integration

WC Integration MaxMind Geolocation

Extended by individual integrations to offer additional functionality.

Tags
since
3.9.0

Table of Contents

$enabled  : string
Yes or no based on whether the integration is enabled.
$errors  : array
Validation errors.
$form_fields  : array
Form option fields.
$id  : string
ID of the class extending the settings API. Used in option names.
$method_description  : string
Integration description.
$method_title  : string
Integration title.
$plugin_id  : string
The plugin ID. Used for option names.
$settings  : array
Setting values.
$data  : array
The posted settings data. When empty, $_POST data will be used.
$database_service  : WC_Integration_MaxMind_Database_Service
The service responsible for interacting with the MaxMind database.
__construct()  : mixed
Initialize the integration.
add_error()  : mixed
Add an error message for display in admin on save.
admin_options()  : mixed
Override the normal options so we can print the database file path to the admin,
display_errors()  : mixed
Display admin error messages.
display_missing_license_key_notice()  : mixed
Display notice if license key is missing.
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_custom_attribute_html()  : string
Get custom attributes.
get_database_service()  : WC_Integration_MaxMind_Database_Service|null
Get database service.
get_description_html()  : string
Get HTML for descriptions.
get_errors()  : mixed
Get admin error messages.
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_geolocation()  : array
Performs a geolocation lookup against the MaxMind database for the given IP address.
get_method_description()  : string
Return the description for admin screens.
get_method_title()  : string
Return the title for admin screens.
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_tooltip_html()  : string
Get HTML for tooltips.
init_form_fields()  : mixed
Initializes the settings fields.
init_settings()  : mixed
Initialise Settings.
process_admin_options()  : bool
Processes and saves options.
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.
update_database()  : mixed
Updates the database used for geolocation queries.
update_option()  : bool
Update a single option.
validate_checkbox_field()  : string
Validate Checkbox Field.
validate_decimal_field()  : string
Validate Decimal Field.
validate_license_key_field()  : mixed
Checks to make sure that the license key is valid.
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.
set_defaults()  : array
Set default required properties for each field.
add_missing_license_key_notice()  : mixed
Add missing license key notice.
get_database_prefix()  : string
Fetches the prefix for the MaxMind database file.
remove_missing_license_key_notice()  : mixed
Remove missing license key notice.

Properties

Methods

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_geolocation()

Performs a geolocation lookup against the MaxMind database for the given IP address.

public get_geolocation(array $data, string $ip_address) : array
Parameters
$data : array

Geolocation data.

$ip_address : string

The IP address to geolocate.

Return values
arrayGeolocation including country code, state, city and postcode based on an IP address.

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.

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

process_admin_options()

Processes and saves options.

public process_admin_options() : bool

If there is an error thrown, will continue to save and validate fields, but will leave the erroring field out.

Return values
boolwas anything saved?

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

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