GF_Field_Address
Source: includes/fields/class-gf-field-address.php:7
Details
- Kind:
class - Namespace:
(global) - Extends: GF_Field
Properties
| Property | Type | Description |
|---|---|---|
$repeatable | bool | Whether the field can be used in a repeater. |
$_supports_state_validation | bool | Indicates if this field supports state validation. |
$noURLs | bool | Whether this field allows links/URLs in the value. |
Methods
| Method | Description |
|---|---|
get_form_editor_field_description() | Returns the field's form editor description. |
get_form_editor_field_icon() | Returns the field's form editor icon. |
get_required_inputs_ids() | Defines the IDs of required inputs. |
get_field_container_tag() | Returns the HTML tag for the field container. |
validate() | Validates the address field inputs. |
get_default_address_type() | Retrieve the default address type for this field. |
get_selected_address_type() | Returns the properties of the selected address type. |
get_state_field() | Generates state field markup. |
get_countries() | Returns a list of countries. |
get_default_countries() | Returns the default array of countries using the ISO 3166-1 alpha-2 code as the key to the country name. |
get_country_code() | Returns the ISO 3166-1 alpha-2 code for the supplied country name. |
get_country_codes() | Returns the default countries array updated to use the uppercase country name as the key to the ISO 3166-1 alpha-2 code. |
is_country_code() | Checks if the given value is an ISO 3166-1 alpha-2 country code that exists in our default list of countries. |
get_country_name() | Returns the country name for the given ISO 3166-1 alpha-2 country code. |
get_us_states() | Returns the array of US states and territories. |
get_default_us_states() | Returns the default array of US states using the 2-character state codes as the keys. |
get_us_state_code() | Returns the two-letter US state code from the state name provided. |
get_select_option() | Returns the option tag for the current choice. |
get_value_merge_tag() | Format the entry value for when the field/input merge tag is processed. Not called for the {all_fields} merge tag. |
get_value_entry_list() | Format the entry value for display on the entries list page. |
get_value_entry_detail() | Format the entry value for display on the entry detail page and for the {all_fields} merge tag. |
get_first_input_id() | Removes the "for" attribute in the field label. Inputs are only allowed one label (a11y) and the inputs already have labels. |
get_filter_sub_filters() | Returns the sub-filters for the current field. |
get_filter_operators() | Returns the filter operators for the current field. |
skip_state_validation_if_blank() | Indicates if state validation should be skipped if the submitted value is blank. |
get_values_for_state_hash() | Prepares the value that will be hashed on form display as part of the state. |
post_convert_field() | Actions to be performed after the field has been converted to an object. |
Method Reference
get_form_editor_field_description()
public function get_form_editor_field_description()
Returns the field's form editor description.
Returns
string
Since: 2.5
Source: includes/fields/class-gf-field-address.php:74
get_form_editor_field_icon()
public function get_form_editor_field_icon()
Returns the field's form editor icon.
This could be an icon url or a gform-icon class.
Returns
string
Since: 2.5
Source: includes/fields/class-gf-field-address.php:87
get_required_inputs_ids()
public function get_required_inputs_ids()
Defines the IDs of required inputs.
Returns
string[]
Since: 2.5
Source: includes/fields/class-gf-field-address.php:98
get_field_container_tag()
public function get_field_container_tag( $form )
Returns the HTML tag for the field container.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form | array | The current Form object. |
Returns
string
Since: 2.5
Source: includes/fields/class-gf-field-address.php:112
validate()
public function validate( $value, $form )
Validates the address field inputs.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | array | The field value from get_value_submission(). | |
$form | array | The Form Object currently being processed. |
Returns
void
Since:
1.92.6.5(Updated to use set_required_error().)
Source: includes/fields/class-gf-field-address.php:133
get_default_address_type()
public function get_default_address_type( $form_id )
Retrieve the default address type for this field.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form_id | int | The current form ID. |
Returns
string
Source: includes/fields/class-gf-field-address.php:548
get_selected_address_type()
public function get_selected_address_type()
Returns the properties of the selected address type.
Returns
array
Since: 3.0
Source: includes/fields/class-gf-field-address.php:568
get_state_field()
public function get_state_field( $id, $field_id, $state_value, $disabled_text, $form_id, $aria_attributes='', $address_state_field_input='' )
Generates state field markup.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$id | integer | Input id. | |
$field_id | integer | Field id. | |
$state_value | string | State value. | |
$disabled_text | string | Disabled attribute. | |
$form_id | integer | Current form id being processed. | |
$aria_attributes | string | '' | Aria attributes values. |
$address_state_field_input | '' |
Returns
string
Since:
unknown2.5(added new params $$aria_attributes.)
Source: includes/fields/class-gf-field-address.php:593
get_countries()
public function get_countries()
Returns a list of countries.
Returns
array
Since:
Unknown2.4(Updated to use ISO 3166-1 list of countries.)2.4.20(Updated to use GF_Field_Address::get_default_countries() and to sort the countries.)3.0.3(Updated to use the country codes as the keys.)
Source: includes/fields/class-gf-field-address.php:654
get_default_countries()
public function get_default_countries()
Returns the default array of countries using the ISO 3166-1 alpha-2 code as the key to the country name.
Returns
array
Since:
2.4.203.0.3(Added static caching.)
Source: includes/fields/class-gf-field-address.php:684
get_country_code()
public function get_country_code( $country_name, $bypass_is_code_check=false )
Returns the ISO 3166-1 alpha-2 code for the supplied country name.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$country_name | string | The country name. | |
$bypass_is_code_check | bool | false | Whether to bypass the check for $country_name already being an ISO 3166-1 alpha-2 code. Defaults to false. |
Returns
string
Since:
Unknown3.0.3(Added the optional $bypass_is_code_check param.)
Source: includes/fields/class-gf-field-address.php:957
get_country_codes()
public function get_country_codes()
Returns the default countries array updated to use the uppercase country name as the key to the ISO 3166-1 alpha-2 code.
Returns
array
Since:
Unknown2.4(Updated to use ISO 3166-1 list of countries.)2.4.20(Updated to use GF_Field_Address::get_default_countries().)
Source: includes/fields/class-gf-field-address.php:980
is_country_code()
public function is_country_code( $value )
Checks if the given value is an ISO 3166-1 alpha-2 country code that exists in our default list of countries.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | The value to check. |
Returns
bool
Since: 3.0.3
Source: includes/fields/class-gf-field-address.php:998
get_country_name()
public function get_country_name( $country_code )
Returns the country name for the given ISO 3166-1 alpha-2 country code.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$country_code | string | The ISO 3166-1 alpha-2 country code. |
Returns
string
Since: 3.0.3
Source: includes/fields/class-gf-field-address.php:1011
get_us_states()
public function get_us_states()
Returns the array of US states and territories.
Returns
array— The array of US states.
Since: Unknown
Source: includes/fields/class-gf-field-address.php:1026
get_default_us_states()
public function get_default_us_states()
Returns the default array of US states using the 2-character state codes as the keys.
Returns
array
Since: 3.0.3
Source: includes/fields/class-gf-field-address.php:1046
get_us_state_code()
public function get_us_state_code( $state_name )
Returns the two-letter US state code from the state name provided.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$state_name | string | The state name. |
Returns
string— The two-letter US state code.
Since: Unknown
Source: includes/fields/class-gf-field-address.php:1127
get_select_option()
public function get_select_option( $value, $label, $selected_value )
Returns the option tag for the current choice.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | The choice value. | |
$label | string | The choice label. | |
$selected_value | string | The value for the selected choice. |
Returns
string
Source: includes/fields/class-gf-field-address.php:1192
get_value_merge_tag()
public function get_value_merge_tag( $value, $input_id, $entry, $form, $modifier, $raw_value, $url_encode, $esc_html, $format, $nl2br )
Format the entry value for when the field/input merge tag is processed. Not called for the {all_fields} merge tag.
Returns the country name instead of the country code, unless the code modifier is used.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | array | The field value. Depending on the location the merge tag is being used the following functions may have already been applied to the value: esc_html, nl2br, and urlencode. | |
$input_id | string | The field or input ID from the merge tag currently being processed. | |
$entry | array | The Entry Object currently being processed. | |
$form | array | The Form Object currently being processed. | |
$modifier | string | The merge tag modifier. e.g. value | |
$raw_value | string | array | The raw field value from before any formatting was applied to $value. | |
$url_encode | bool | Indicates if the urlencode function may have been applied to the $value. | |
$esc_html | bool | Indicates if the esc_html function may have been applied to the $value. | |
$format | string | The format requested for the location the merge is being used. Possible values: html, text or url. | |
$nl2br | bool | Indicates if the nl2br function may have been applied to the $value. |
Returns
string
Since: 3.0.3
Source: includes/fields/class-gf-field-address.php:1269
get_value_entry_list()
public function get_value_entry_list( $value, $entry, $field_id, $columns, $form )
Format the entry value for display on the entries list page.
Returns the country name instead of the country code.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | array | The field value. | |
$entry | array | The Entry Object currently being processed. | |
$field_id | string | The field or input ID currently being processed. | |
$columns | array | The properties for the columns being displayed on the entry list page. | |
$form | array | The Form Object currently being processed. |
Returns
string
Since: 3.0.3
Source: includes/fields/class-gf-field-address.php:1292
get_value_entry_detail()
public function get_value_entry_detail( $value, $entry=[], $use_text=false, $format='html', $media='screen' )
Format the entry value for display on the entry detail page and for the {all_fields} merge tag.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | array | The field value. | |
$entry | array | [] | The entry. |
$use_text | bool | false | false | When processing choice based fields should the choice text be returned instead of the value. |
$format | string | 'html' | The format requested for the location the merge is being used. Possible values: html, text or url. |
$media | string | 'screen' | The location where the value will be displayed. Possible values: screen or email. |
Returns
string
Since:
1.92.9.29(Changed the second parameter $currency (string) to $entry (array).)
Source: includes/fields/class-gf-field-address.php:1314
get_first_input_id()
public function get_first_input_id( $form )
Removes the "for" attribute in the field label. Inputs are only allowed one label (a11y) and the inputs already have labels.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form | array | The Form Object currently being processed. |
Returns
string
Since: 2.4
Source: includes/fields/class-gf-field-address.php:1479
get_filter_sub_filters()
public function get_filter_sub_filters()
Returns the sub-filters for the current field.
Returns
array
Since: 2.4
Source: includes/fields/class-gf-field-address.php:1492
get_filter_operators()
public function get_filter_operators()
Returns the filter operators for the current field.
Returns
array
Since: 2.4
Source: includes/fields/class-gf-field-address.php:1519
skip_state_validation_if_blank()
public function skip_state_validation_if_blank( $key )
Indicates if state validation should be skipped if the submitted value is blank.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$key | string | int | The field or input ID. |
Returns
bool
Since: 3.0
Source: includes/fields/class-gf-field-address.php:1535
get_values_for_state_hash()
public function get_values_for_state_hash( $value )
Prepares the value that will be hashed on form display as part of the state.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | array | The default value. |
Returns
null|array
Since: 3.0
Source: includes/fields/class-gf-field-address.php:1556
post_convert_field()
public function post_convert_field()
Actions to be performed after the field has been converted to an object.
Returns
void
Since: 3.0.3
Source: includes/fields/class-gf-field-address.php:1611