woocommerce/includes/class-wc-countries.php

956 lines
27 KiB
PHP
Raw Normal View History

2011-08-09 15:16:18 +00:00
<?php
/**
2011-08-10 17:11:11 +00:00
* WooCommerce countries
2012-08-06 22:43:39 +00:00
*
2011-08-10 17:11:11 +00:00
* The WooCommerce countries class stores country/state data.
2011-08-09 15:16:18 +00:00
*
2012-01-27 16:38:39 +00:00
* @class WC_Countries
* @version 2.2.0
2012-08-14 22:43:48 +00:00
* @package WooCommerce/Classes
2013-02-20 17:14:46 +00:00
* @category Class
2012-08-14 19:42:38 +00:00
* @author WooThemes
2011-08-09 15:16:18 +00:00
*/
2012-01-27 16:38:39 +00:00
class WC_Countries {
2012-08-06 22:43:39 +00:00
2012-08-15 17:08:42 +00:00
/** @var array Array of locales */
public $locale;
2012-08-14 19:42:38 +00:00
2012-08-15 17:08:42 +00:00
/** @var array Array of address formats for locales */
public $address_formats;
2012-08-06 22:43:39 +00:00
/**
* Auto-load in-accessible properties on demand.
2012-08-14 19:42:38 +00:00
*
* @param mixed $key
* @return mixed
*/
public function __get( $key ) {
if ( 'countries' == $key ) {
return $this->get_countries();
} elseif ( 'states' == $key ) {
return $this->get_states();
}
}
/**
* Get all countries
* @return array
*/
public function get_countries() {
if ( empty( $this->countries ) ) {
$this->countries = apply_filters( 'woocommerce_countries', include( WC()->plugin_path() . '/i18n/countries.php' ) );
if ( apply_filters('woocommerce_sort_countries', true ) ) {
asort( $this->countries );
}
}
return $this->countries;
}
2012-08-06 22:43:39 +00:00
/**
* Load the states
*/
public function load_country_states() {
global $states;
2012-08-06 22:43:39 +00:00
// States set to array() are blank i.e. the country has no use for the state field.
$states = array(
2012-07-26 16:29:49 +00:00
'AF' => array(),
'AT' => array(),
2012-02-28 10:12:13 +00:00
'BE' => array(),
2012-07-26 16:29:49 +00:00
'BI' => array(),
'CZ' => array(),
'DE' => array(),
'DK' => array(),
2013-09-10 12:41:40 +00:00
'EE' => array(),
'FI' => array(),
'FR' => array(),
'IS' => array(),
'IL' => array(),
2013-01-20 12:50:39 +00:00
'KR' => array(),
'NL' => array(),
'NO' => array(),
'PL' => array(),
'PT' => array(),
'SG' => array(),
'SK' => array(),
'SI' => array(),
'LK' => array(),
'SE' => array(),
'VN' => array(),
);
// Load only the state files the shop owner wants/needs
$allowed = array_merge( $this->get_allowed_countries(), $this->get_shipping_countries() );
if ( $allowed ) {
foreach ( $allowed as $code => $country ) {
if ( ! isset( $states[ $code ] ) && file_exists( WC()->plugin_path() . '/i18n/states/' . $code . '.php' ) ) {
include( WC()->plugin_path() . '/i18n/states/' . $code . '.php' );
}
}
}
$this->states = apply_filters( 'woocommerce_states', $states );
}
/**
* Get the states for a country.
*
* @access public
* @param string $cc country code
* @return array of states
*/
2014-05-30 12:33:09 +00:00
public function get_states( $cc = null ) {
if ( empty( $this->states ) ) {
$this->load_country_states();
}
2014-05-30 12:33:09 +00:00
if ( ! is_null( $cc ) ) {
return isset( $this->states[ $cc ] ) ? $this->states[ $cc ] : false;
} else {
return $this->states;
}
}
2012-08-14 19:42:38 +00:00
/**
* Get the base country for the store.
*
* @access public
* @return string
*/
public function get_base_country() {
2012-10-18 10:33:47 +00:00
$default = esc_attr( get_option('woocommerce_default_country') );
2013-09-27 19:31:59 +00:00
$country = ( ( $pos = strrpos( $default, ':' ) ) === false ) ? $default : substr( $default, 0, $pos );
return apply_filters( 'woocommerce_countries_base_country', $country );
}
2012-08-14 19:42:38 +00:00
/**
* Get the base state for the store.
2012-08-14 19:42:38 +00:00
*
* @access public
* @return string
*/
public function get_base_state() {
$default = wc_clean( get_option( 'woocommerce_default_country' ) );
$state = ( ( $pos = strrpos( $default, ':' ) ) === false ) ? '' : substr( $default, $pos + 1 );
return apply_filters( 'woocommerce_countries_base_state', $state );
}
/**
* Get the base city for the store.
*
* @access public
* @return string
*/
public function get_base_city() {
return apply_filters( 'woocommerce_countries_base_city', '' );
}
/**
* Get the base postcode for the store.
*
* @access public
* @return string
*/
public function get_base_postcode() {
return apply_filters( 'woocommerce_countries_base_postcode', '' );
2011-08-09 15:16:18 +00:00
}
2012-08-14 19:42:38 +00:00
/**
* Get the allowed countries for the store.
*
* @access public
* @return array
*/
public function get_allowed_countries() {
if ( get_option('woocommerce_allowed_countries') !== 'specific' ) {
return $this->countries;
}
2011-08-09 15:16:18 +00:00
$countries = array();
2012-08-06 22:43:39 +00:00
$raw_countries = get_option( 'woocommerce_specific_allowed_countries' );
2012-08-06 22:43:39 +00:00
foreach ( $raw_countries as $country )
$countries[ $country ] = $this->countries[ $country ];
2012-08-06 22:43:39 +00:00
return apply_filters( 'woocommerce_countries_allowed_countries', $countries );
2011-08-09 15:16:18 +00:00
}
2012-11-27 16:22:47 +00:00
/**
* Get the countries you ship to.
*
* @access public
* @return array
*/
public function get_shipping_countries() {
if ( get_option( 'woocommerce_ship_to_countries' ) == '' )
return $this->get_allowed_countries();
if ( get_option('woocommerce_ship_to_countries') !== 'specific' )
return $this->countries;
$countries = array();
$raw_countries = get_option( 'woocommerce_specific_ship_to_countries' );
foreach ( $raw_countries as $country )
$countries[ $country ] = $this->countries[ $country ];
return apply_filters( 'woocommerce_countries_shipping_countries', $countries );
}
2012-11-27 16:22:47 +00:00
/**
* get_allowed_country_states function.
2012-11-27 16:22:47 +00:00
*
* @access public
* @return array
*/
public function get_allowed_country_states() {
2012-11-27 16:22:47 +00:00
if ( get_option('woocommerce_allowed_countries') !== 'specific' )
return $this->states;
$states = array();
$raw_countries = get_option( 'woocommerce_specific_allowed_countries' );
foreach ( $raw_countries as $country )
if ( isset( $this->states[ $country ] ) )
$states[ $country ] = $this->states[ $country ];
return apply_filters( 'woocommerce_countries_allowed_country_states', $states );
}
2012-08-06 22:43:39 +00:00
/**
* get_shipping_country_states function.
*
* @access public
* @return array
*/
public function get_shipping_country_states() {
if ( get_option( 'woocommerce_ship_to_countries' ) == '' )
return $this->get_allowed_country_states();
if ( get_option( 'woocommerce_ship_to_countries' ) !== 'specific' )
return $this->states;
$states = array();
$raw_countries = get_option( 'woocommerce_specific_ship_to_countries' );
foreach ( $raw_countries as $country )
if ( ! empty( $this->states[ $country ] ) )
$states[ $country ] = $this->states[ $country ];
return apply_filters( 'woocommerce_countries_shipping_country_states', $states );
}
2012-08-14 19:42:38 +00:00
/**
* Gets an array of countries in the EU.
*
* @access public
* @return array
*/
public function get_european_union_countries() {
return array( 'AT', 'BE', 'BG', 'CY', 'CZ', 'DE', 'DK', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HU', 'HR', 'IE', 'IT', 'LT', 'LU', 'LV', 'MT', 'NL', 'PL', 'PT', 'RO', 'SE', 'SI', 'SK' );
2011-10-31 10:54:49 +00:00
}
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
/**
* Gets the correct string for shipping - ether 'to the' or 'to'
*
* @access public
* @return string
*/
public function shipping_to_prefix() {
2011-08-09 15:16:18 +00:00
$return = '';
2013-11-25 14:01:32 +00:00
if (in_array(WC()->customer->get_shipping_country(), array( 'GB', 'US', 'AE', 'CZ', 'DO', 'NL', 'PH', 'USAF' ))) $return = __( 'to the', 'woocommerce' );
2012-10-16 09:45:33 +00:00
else $return = __( 'to', 'woocommerce' );
2013-11-25 14:01:32 +00:00
return apply_filters('woocommerce_countries_shipping_to_prefix', $return, WC()->customer->get_shipping_country());
2011-08-09 15:16:18 +00:00
}
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
/**
* Prefix certain countries with 'the'
*
* @access public
* @return string
*/
public function estimated_for_prefix() {
2011-08-09 15:16:18 +00:00
$return = '';
2012-10-16 09:45:33 +00:00
if (in_array($this->get_base_country(), array( 'GB', 'US', 'AE', 'CZ', 'DO', 'NL', 'PH', 'USAF' ))) $return = __( 'the', 'woocommerce' ) . ' ';
return apply_filters('woocommerce_countries_estimated_for_prefix', $return, $this->get_base_country());
2011-10-31 10:54:49 +00:00
}
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
/**
* Correctly name tax in some countries VAT on the frontend
*
* @access public
* @return string
*/
public function tax_or_vat() {
2012-10-16 09:45:33 +00:00
$return = ( in_array($this->get_base_country(), $this->get_european_union_countries()) ) ? __( 'VAT', 'woocommerce' ) : __( 'Tax', 'woocommerce' );
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
return apply_filters( 'woocommerce_countries_tax_or_vat', $return );
2011-10-31 10:54:49 +00:00
}
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
/**
* Include the Inc Tax label.
*
* @access public
* @return string
*/
public function inc_tax_or_vat() {
2012-10-16 09:45:33 +00:00
$return = ( in_array($this->get_base_country(), $this->get_european_union_countries()) ) ? __( '(incl. VAT)', 'woocommerce' ) : __( '(incl. tax)', 'woocommerce' );
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
return apply_filters( 'woocommerce_countries_inc_tax_or_vat', $return );
2011-10-31 10:54:49 +00:00
}
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
/**
* Include the Ex Tax label.
*
* @access public
* @return string
*/
public function ex_tax_or_vat() {
2012-10-16 09:45:33 +00:00
$return = ( in_array($this->get_base_country(), $this->get_european_union_countries()) ) ? __( '(ex. VAT)', 'woocommerce' ) : __( '(ex. tax)', 'woocommerce' );
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
return apply_filters( 'woocommerce_countries_ex_tax_or_vat', $return );
2011-08-09 15:16:18 +00:00
}
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
/**
* Outputs the list of countries and states for use in dropdown boxes.
*
* @access public
* @param string $selected_country (default: '')
* @param string $selected_state (default: '')
* @param bool $escape (default: false)
* @return void
*/
public function country_dropdown_options( $selected_country = '', $selected_state = '', $escape = false ) {
if ( $this->countries ) foreach ( $this->countries as $key=>$value) :
if ( $states = $this->get_states( $key ) ) :
2013-11-20 19:11:59 +00:00
echo '<optgroup label="' . esc_attr( $value ) . '">';
2011-08-09 15:16:18 +00:00
foreach ($states as $state_key=>$state_value) :
2013-11-20 19:11:59 +00:00
echo '<option value="' . esc_attr( $key ) . ':'.$state_key.'"';
2012-08-06 22:43:39 +00:00
2011-08-09 15:16:18 +00:00
if ($selected_country==$key && $selected_state==$state_key) echo ' selected="selected"';
2012-08-06 22:43:39 +00:00
2011-08-09 15:16:18 +00:00
echo '>'.$value.' &mdash; '. ($escape ? esc_js($state_value) : $state_value) .'</option>';
endforeach;
echo '</optgroup>';
else :
echo '<option';
if ($selected_country==$key && $selected_state=='*') echo ' selected="selected"';
2013-11-20 19:11:59 +00:00
echo ' value="' . esc_attr( $key ) . '">'. ($escape ? esc_js( $value ) : $value) .'</option>';
2011-08-09 15:16:18 +00:00
endif;
endforeach;
}
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
/**
* Get country address formats
*
* @access public
* @return array
*/
public function get_address_formats() {
2012-08-06 22:43:39 +00:00
if (!$this->address_formats) :
2012-08-06 22:43:39 +00:00
// Common formats
$postcode_before_city = "{company}\n{name}\n{address_1}\n{address_2}\n{postcode} {city}\n{country}";
2012-08-06 22:43:39 +00:00
// Define address formats
$this->address_formats = apply_filters('woocommerce_localisation_address_formats', array(
'default' => "{name}\n{company}\n{address_1}\n{address_2}\n{city}\n{state}\n{postcode}\n{country}",
'AU' => "{name}\n{company}\n{address_1}\n{address_2}\n{city} {state} {postcode}\n{country}",
'AT' => $postcode_before_city,
'BE' => $postcode_before_city,
'CA' => "{company}\n{name}\n{address_1}\n{address_2}\n{city} {state} {postcode}\n{country}",
2012-07-10 12:36:13 +00:00
'CH' => $postcode_before_city,
'CN' => "{country} {postcode}\n{state}, {city}, {address_2}, {address_1}\n{company}\n{name}",
'CZ' => $postcode_before_city,
'DE' => $postcode_before_city,
2013-09-10 12:41:40 +00:00
'EE' => $postcode_before_city,
'FI' => $postcode_before_city,
'DK' => $postcode_before_city,
'FR' => "{company}\n{name}\n{address_1}\n{address_2}\n{postcode} {city_upper}\n{country}",
'HK' => "{company}\n{first_name} {last_name_upper}\n{address_1}\n{address_2}\n{city_upper}\n{state_upper}\n{country}",
'HU' => "{name}\n{company}\n{city}\n{address_1}\n{address_2}\n{postcode}\n{country}",
'IS' => $postcode_before_city,
2014-02-13 12:12:47 +00:00
'IT' => "{company}\n{name}\n{address_1}\n{address_2}\n{postcode}\n{city}\n{state_upper}\n{country}",
'JP' => "{postcode}\n{state}{city}{address_2}\n{address_1}\n{company}\n{last_name} {first_name}\n {country}",
2014-05-19 08:08:30 +00:00
'TW' => "{postcode}\n{city}{address_2}\n{address_1}\n{company}\n{last_name} {first_name}\n {country}",
2012-07-10 12:36:13 +00:00
'LI' => $postcode_before_city,
'NL' => $postcode_before_city,
'NZ' => "{name}\n{company}\n{address_1}\n{address_2}\n{city} {postcode}\n{country}",
'NO' => $postcode_before_city,
'PL' => $postcode_before_city,
'SK' => $postcode_before_city,
'SI' => $postcode_before_city,
'ES' => "{name}\n{company}\n{address_1}\n{address_2}\n{postcode} {city}\n{state}\n{country}",
'SE' => $postcode_before_city,
'TR' => "{name}\n{company}\n{address_1}\n{address_2}\n{postcode} {city} {state}\n{country}",
'US' => "{name}\n{company}\n{address_1}\n{address_2}\n{city}, {state} {postcode}\n{country}",
'VN' => "{name}\n{company}\n{address_1}\n{city}\n{country}",
));
endif;
2012-08-06 22:43:39 +00:00
return $this->address_formats;
}
2012-08-06 22:43:39 +00:00
2012-08-14 19:42:38 +00:00
/**
* Get country address format
*
* @access public
* @param array $args (default: array())
* @return string address
*/
public function get_formatted_address( $args = array() ) {
2012-08-06 22:43:39 +00:00
2012-10-16 15:22:07 +00:00
$args = array_map( 'trim', $args );
2012-08-06 22:43:39 +00:00
extract( $args );
2012-08-06 22:43:39 +00:00
// Get all formats
2011-12-18 13:41:42 +00:00
$formats = $this->get_address_formats();
2012-08-06 22:43:39 +00:00
// Get format for the address' country
2012-10-16 15:22:07 +00:00
$format = ( $country && isset( $formats[ $country ] ) ) ? $formats[ $country ] : $formats['default'];
2012-08-06 22:43:39 +00:00
// Handle full country name
2012-10-16 15:22:07 +00:00
$full_country = ( isset( $this->countries[ $country ] ) ) ? $this->countries[ $country ] : $country;
2012-08-06 22:43:39 +00:00
// Country is not needed if the same as base
if ( $country == $this->get_base_country() && ! apply_filters( 'woocommerce_formatted_address_force_country_display', false ) )
2012-10-16 15:22:07 +00:00
$format = str_replace( '{country}', '', $format );
2012-08-06 22:43:39 +00:00
2011-12-18 13:41:42 +00:00
// Handle full state name
2012-10-16 15:22:07 +00:00
$full_state = ( $country && $state && isset( $this->states[ $country ][ $state ] ) ) ? $this->states[ $country ][ $state ] : $state;
2012-08-06 22:43:39 +00:00
// Substitute address parts into the string
$replace = array_map( 'esc_html', apply_filters( 'woocommerce_formatted_address_replacements', array(
'{first_name}' => $first_name,
'{last_name}' => $last_name,
'{name}' => $first_name . ' ' . $last_name,
'{company}' => $company,
'{address_1}' => $address_1,
'{address_2}' => $address_2,
'{city}' => $city,
'{state}' => $full_state,
'{postcode}' => $postcode,
'{country}' => $full_country,
2012-10-16 15:22:07 +00:00
'{first_name_upper}' => strtoupper( $first_name ),
'{last_name_upper}' => strtoupper( $last_name ),
'{name_upper}' => strtoupper( $first_name . ' ' . $last_name ),
'{company_upper}' => strtoupper( $company ),
'{address_1_upper}' => strtoupper( $address_1 ),
'{address_2_upper}' => strtoupper( $address_2 ),
'{city_upper}' => strtoupper( $city ),
'{state_upper}' => strtoupper( $full_state ),
'{postcode_upper}' => strtoupper( $postcode ),
'{country_upper}' => strtoupper( $full_country ),
), $args ) );
2012-10-16 15:22:07 +00:00
$formatted_address = str_replace( array_keys( $replace ), $replace, $format );
2012-08-06 22:43:39 +00:00
2012-01-15 06:31:47 +00:00
// Clean up white space
2012-10-16 15:22:07 +00:00
$formatted_address = preg_replace( '/ +/', ' ', trim( $formatted_address ) );
$formatted_address = preg_replace( '/\n\n+/', "\n", $formatted_address );
2012-08-06 22:43:39 +00:00
// Break newlines apart and remove empty lines/trim commas and white space
$formatted_address = array_filter( array_map( array( $this, 'trim_formatted_address_line' ), explode( "\n", $formatted_address ) ) );
// Add html breaks
$formatted_address = implode( '<br/>', $formatted_address );
2012-08-06 22:43:39 +00:00
// We're done!
return $formatted_address;
}
2012-08-06 22:43:39 +00:00
/**
* trim white space and commans off a line
* @param string
* @return string
*/
private function trim_formatted_address_line( $line ) {
return trim( $line, ", " );
}
/**
* Returns the fields we show by default. This can be filtered later on.
*
* @access public
* @return array
*/
public function get_default_address_fields() {
$fields = array(
'country' => array(
'type' => 'country',
'label' => __( 'Country', 'woocommerce' ),
'required' => true,
'class' => array( 'form-row-wide', 'address-field', 'update_totals_on_change' ),
),
'first_name' => array(
'label' => __( 'First Name', 'woocommerce' ),
'required' => true,
'class' => array( 'form-row-first' ),
),
'last_name' => array(
'label' => __( 'Last Name', 'woocommerce' ),
'required' => true,
'class' => array( 'form-row-last' ),
'clear' => true
),
'company' => array(
'label' => __( 'Company Name', 'woocommerce' ),
'class' => array( 'form-row-wide' ),
),
'address_1' => array(
'label' => __( 'Address', 'woocommerce' ),
'placeholder' => _x( 'Street address', 'placeholder', 'woocommerce' ),
'required' => true,
'class' => array( 'form-row-wide', 'address-field' )
),
'address_2' => array(
'placeholder' => _x( 'Apartment, suite, unit etc. (optional)', 'placeholder', 'woocommerce' ),
'class' => array( 'form-row-wide', 'address-field' ),
'required' => false
),
'city' => array(
'label' => __( 'Town / City', 'woocommerce' ),
'placeholder' => __( 'Town / City', 'woocommerce' ),
'required' => true,
'class' => array( 'form-row-wide', 'address-field' )
),
'state' => array(
'type' => 'state',
'label' => __( 'State / County', 'woocommerce' ),
'placeholder' => __( 'State / County', 'woocommerce' ),
'required' => true,
'class' => array( 'form-row-first', 'address-field' ),
'validate' => array( 'state' )
),
'postcode' => array(
'label' => __( 'Postcode / Zip', 'woocommerce' ),
'placeholder' => __( 'Postcode / Zip', 'woocommerce' ),
'required' => true,
'class' => array( 'form-row-last', 'address-field' ),
'clear' => true,
'validate' => array( 'postcode' )
),
);
return apply_filters( 'woocommerce_default_address_fields', $fields );
}
/**
2013-12-03 12:14:12 +00:00
* Get JS selectors for fields which are shown/hidden depending on the locale.
*
* @access public
* @return array
*/
2013-12-03 12:14:12 +00:00
public function get_country_locale_field_selectors() {
$locale_fields = array (
'address_1' => '#billing_address_1_field, #shipping_address_1_field',
'address_2' => '#billing_address_2_field, #shipping_address_2_field',
'state' => '#billing_state_field, #shipping_state_field',
'postcode' => '#billing_postcode_field, #shipping_postcode_field',
'city' => '#billing_city_field, #shipping_city_field'
);
2013-12-03 12:14:12 +00:00
return apply_filters( 'woocommerce_country_locale_field_selectors', $locale_fields );
}
2012-08-14 19:42:38 +00:00
/**
* Get country locale settings
*
* @access public
* @return array
*/
public function get_country_locale() {
if ( ! $this->locale ) {
2012-08-06 22:43:39 +00:00
// Locale information used by the checkout
$this->locale = apply_filters('woocommerce_get_country_locale', array(
2013-07-19 14:08:40 +00:00
'AE' => array(
'postcode' => array(
'required' => false,
'hidden' => true
),
),
2012-07-26 16:29:49 +00:00
'AF' => array(
'state' => array(
'required' => false,
),
),
'AT' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'BD' => array(
'postcode' => array(
'required' => false
),
'state' => array(
'label' => __( 'District', 'woocommerce' ),
)
),
2012-02-28 10:12:13 +00:00
'BE' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false,
'label' => __( 'Province', 'woocommerce' ),
2012-02-28 10:12:13 +00:00
),
),
2012-07-26 16:29:49 +00:00
'BI' => array(
'state' => array(
'required' => false,
),
),
2013-11-26 21:41:54 +00:00
'BO' => array(
'postcode' => array(
'required' => false,
'hidden' => true
),
),
'CA' => array(
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Province', 'woocommerce' ),
)
),
2012-07-10 12:36:13 +00:00
'CH' => array(
'postcode_before_city' => true,
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Canton', 'woocommerce' ),
2012-07-10 12:36:13 +00:00
'required' => false
)
),
'CL' => array(
'city' => array(
'required' => false,
),
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Municipality', 'woocommerce' ),
)
),
'CN' => array(
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Province', 'woocommerce' ),
)
),
2012-07-09 14:46:51 +00:00
'CO' => array(
'postcode' => array(
'required' => false
)
),
2012-02-12 15:37:57 +00:00
'CZ' => array(
'state' => array(
'required' => false
)
),
'DE' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'DK' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
2013-09-10 12:41:40 +00:00
'EE' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'FI' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'FR' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'HK' => array(
'postcode' => array(
'required' => false
),
'city' => array(
'label' => __( 'Town / District', 'woocommerce' ),
),
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Region', 'woocommerce' ),
)
),
'HU' => array(
2013-08-01 14:58:48 +00:00
'state' => array(
'label' => __( 'County', 'woocommerce' ),
)
),
'ID' => array(
'state' => array(
'label' => __( 'Province', 'woocommerce' ),
)
),
'IS' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'IL' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'IT' => array(
'postcode_before_city' => true,
'state' => array(
'required' => true,
'label' => __( 'Province', 'woocommerce' ),
)
),
'JP' => array(
'state' => array(
'label' => __( 'Prefecture', 'woocommerce' )
)
),
'KR' => array(
'state' => array(
'required' => false
)
),
'NL' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false,
'label' => __( 'Province', 'woocommerce' ),
)
),
'NZ' => array(
'state' => array(
'required' => false
)
),
'NO' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'PL' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
2013-03-19 21:33:01 +00:00
'PT' => array(
'state' => array(
'required' => false
)
),
'RO' => array(
'state' => array(
'required' => false
)
),
'SG' => array(
'state' => array(
'required' => false
)
),
'SK' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'SI' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'ES' => array(
'postcode_before_city' => true,
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Province', 'woocommerce' ),
)
),
2012-07-10 12:36:13 +00:00
'LI' => array(
'postcode_before_city' => true,
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Municipality', 'woocommerce' ),
2012-07-10 12:36:13 +00:00
'required' => false
)
),
'LK' => array(
'state' => array(
'required' => false
)
),
'SE' => array(
'postcode_before_city' => true,
'state' => array(
'required' => false
)
),
'TR' => array(
'postcode_before_city' => true,
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Province', 'woocommerce' ),
)
),
'US' => array(
'postcode' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Zip', 'woocommerce' ),
),
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'State', 'woocommerce' ),
)
),
'GB' => array(
'postcode' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Postcode', 'woocommerce' ),
),
'state' => array(
2012-10-16 09:45:33 +00:00
'label' => __( 'County', 'woocommerce' ),
2012-03-26 19:35:55 +00:00
'required' => false
)
),
'VN' => array(
'state' => array(
'required' => false
),
'postcode' => array(
'required' => false,
'hidden' => true
),
'address_2' => array(
'required' => false,
'hidden' => true
)
2012-08-06 22:43:39 +00:00
),
2013-03-07 11:01:06 +00:00
'WS' => array(
'postcode' => array(
'required' => false,
'hidden' => true
),
),
'ZA' => array(
'state' => array(
'label' => __( 'Province', 'woocommerce' ),
)
),
2013-02-01 14:53:44 +00:00
'ZW' => array(
'postcode' => array(
'required' => false,
'hidden' => true
),
),
));
2012-08-06 22:43:39 +00:00
$this->locale = array_intersect_key( $this->locale, array_merge( $this->get_allowed_countries(), $this->get_shipping_countries() ) );
2012-08-06 22:43:39 +00:00
// Default Locale Can be filters to override fields in get_address_fields().
// Countries with no specific locale will use default.
$this->locale['default'] = apply_filters('woocommerce_get_country_locale_default', $this->get_default_address_fields() );
2012-08-06 22:43:39 +00:00
// Filter default AND shop base locales to allow overides via a single function. These will be used when changing countries on the checkout
if ( ! isset( $this->locale[ $this->get_base_country() ] ) )
$this->locale[ $this->get_base_country() ] = $this->locale['default'];
2012-08-06 22:43:39 +00:00
$this->locale['default'] = apply_filters( 'woocommerce_get_country_locale_base', $this->locale['default'] );
2012-08-06 22:43:39 +00:00
$this->locale[ $this->get_base_country() ] = apply_filters( 'woocommerce_get_country_locale_base', $this->locale[ $this->get_base_country() ] );
}
2012-08-06 22:43:39 +00:00
return $this->locale;
}
2012-08-06 22:43:39 +00:00
/**
* Apply locale and get address fields
*
* @access public
* @param mixed $country
* @param string $type (default: 'billing_')
* @return array
*/
public function get_address_fields( $country, $type = 'billing_' ) {
if (!$country)
$country = $this->get_base_country();
2013-07-19 14:08:40 +00:00
$fields = $this->get_default_address_fields();
$locale = $this->get_country_locale();
2012-08-06 22:43:39 +00:00
if ( isset( $locale[ $country ] ) ) {
2012-08-06 22:43:39 +00:00
$fields = wc_array_overlay( $fields, $locale[ $country ] );
2012-08-06 22:43:39 +00:00
// If default country has postcode_before_city switch the fields round.
// This is only done at this point, not if country changes on checkout.
if ( isset( $locale[ $country ]['postcode_before_city'] ) ) {
if ( isset( $fields['postcode'] ) ) {
$fields['postcode']['class'] = array( 'form-row-wide', 'address-field' );
2012-08-06 22:43:39 +00:00
$switch_fields = array();
2012-08-06 22:43:39 +00:00
foreach ( $fields as $key => $value ) {
if ( $key == 'city' ) {
// Place postcode before city
$switch_fields['postcode'] = '';
}
$switch_fields[$key] = $value;
2012-07-10 12:36:13 +00:00
}
2012-08-06 22:43:39 +00:00
$fields = $switch_fields;
}
2012-07-10 12:36:13 +00:00
}
}
2012-08-06 22:43:39 +00:00
// Prepend field keys
$address_fields = array();
2012-08-06 22:43:39 +00:00
2012-07-10 12:36:13 +00:00
foreach ( $fields as $key => $value ) {
$address_fields[$type . $key] = $value;
2012-07-10 12:36:13 +00:00
}
2012-08-06 22:43:39 +00:00
// Billing/Shipping Specific
2012-07-10 12:36:13 +00:00
if ( $type == 'billing_' ) {
2011-08-09 15:16:18 +00:00
$address_fields['billing_email'] = array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Email Address', 'woocommerce' ),
2012-08-06 22:43:39 +00:00
'required' => true,
'class' => array( 'form-row-first' ),
'validate' => array( 'email' ),
2012-08-06 22:43:39 +00:00
);
$address_fields['billing_phone'] = array(
2012-10-16 09:45:33 +00:00
'label' => __( 'Phone', 'woocommerce' ),
2012-08-06 22:43:39 +00:00
'required' => true,
'class' => array( 'form-row-last' ),
'clear' => true,
'validate' => array( 'phone' ),
);
2012-08-06 22:43:39 +00:00
2012-07-10 12:36:13 +00:00
}
2012-08-06 22:43:39 +00:00
$address_fields = apply_filters( 'woocommerce_' . $type . 'fields', $address_fields, $country );
// Return
return $address_fields;
}
}