woocommerce_get_country_locale

The WooCommerce woocommerce get country locale hook.

Description

apply_filters( 'woocommerce_get_country_locale', (callback) $array ); 

Parameters (1)

0. $array — Optional. (callback) => array( 'AE' => array( 'postcode' => array( 'required' => false, 'hidden' => true, ), 'state' => array( 'required' => false, ), ), 'AF' => array( 'state' => array( 'required' => false, ), ), 'AT' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'AU' => array( 'city' => array( 'label' => __( 'Suburb', 'woocommerce' ), ), 'postcode' => array( 'label' => __( 'Postcode', 'woocommerce' ), ), 'state' => array( 'label' => __( 'State', 'woocommerce' ), ), ), 'AX' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'BD' => array( 'postcode' => array( 'required' => false, ), 'state' => array( 'label' => __( 'District', 'woocommerce' ), ), ), 'BE' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, 'label' => __( 'Province', 'woocommerce' ), ), ), 'BI' => array( 'state' => array( 'required' => false, ), ), 'BO' => array( 'postcode' => array( 'required' => false, 'hidden' => true, ), ), 'BS' => array( 'postcode' => array( 'required' => false, 'hidden' => true, ), ), 'CA' => array( 'state' => array( 'label' => __( 'Province', 'woocommerce' ), ), ), 'CH' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'label' => __( 'Canton', 'woocommerce' ), 'required' => false, ), ), 'CL' => array( 'city' => array( 'required' => true, ), 'postcode' => array( 'required' => false, ), 'state' => array( 'label' => __( 'Region', 'woocommerce' ), ), ), 'CN' => array( 'state' => array( 'label' => __( 'Province', 'woocommerce' ), ), ), 'CO' => array( 'postcode' => array( 'required' => false, ), ), 'CZ' => array( 'state' => array( 'required' => false, ), ), 'DE' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'DK' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'EE' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'FI' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'FR' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'GP' => array( 'state' => array( 'required' => false, ), ), 'GF' => array( 'state' => array( 'required' => false, ), ), 'HK' => array( 'postcode' => array( 'required' => false, ), 'city' => array( 'label' => __( 'Town / District', 'woocommerce' ), ), 'state' => array( 'label' => __( 'Region', 'woocommerce' ), ), ), 'HU' => array( 'state' => array( 'label' => __( 'County', 'woocommerce' ), ), ), 'ID' => array( 'state' => array( 'label' => __( 'Province', 'woocommerce' ), ), ), 'IE' => array( 'postcode' => array( 'required' => false, 'label' => __( 'Eircode', 'woocommerce' ), ), 'state' => array( 'label' => __( 'County', 'woocommerce' ), ), ), 'IS' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'IL' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'IT' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => true, 'label' => __( 'Province', 'woocommerce' ), ), ), 'JP' => array( 'state' => array( 'label' => __( 'Prefecture', 'woocommerce' ), 'priority' => 66, ), 'postcode' => array( 'priority' => 65, ), ), 'KR' => array( 'state' => array( 'required' => false, ), ), 'KW' => array( 'state' => array( 'required' => false, ), ), 'LB' => array( 'state' => array( 'required' => false, ), ), 'MQ' => array( 'state' => array( 'required' => false, ), ), 'NL' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, 'label' => __( 'Province', 'woocommerce' ), ), ), 'NZ' => array( 'postcode' => array( 'label' => __( 'Postcode', 'woocommerce' ), ), 'state' => array( 'required' => false, 'label' => __( 'Region', 'woocommerce' ), ), ), 'NO' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'NP' => array( 'state' => array( 'label' => __( 'State / Zone', 'woocommerce' ), ), 'postcode' => array( 'required' => false, ), ), 'PL' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'PT' => array( 'state' => array( 'required' => false, ), ), 'RE' => array( 'state' => array( 'required' => false, ), ), 'RO' => array( 'state' => array( 'required' => false, ), ), 'SG' => array( 'state' => array( 'required' => false, ), ), 'SK' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'SI' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'ES' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'label' => __( 'Province', 'woocommerce' ), ), ), 'LI' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'label' => __( 'Municipality', 'woocommerce' ), 'required' => false, ), ), 'LK' => array( 'state' => array( 'required' => false, ), ), 'SE' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'required' => false, ), ), 'TR' => array( 'postcode' => array( 'priority' => 65, ), 'state' => array( 'label' => __( 'Province', 'woocommerce' ), ), ), 'US' => array( 'postcode' => array( 'label' => __( 'ZIP', 'woocommerce' ), ), 'state' => array( 'label' => __( 'State', 'woocommerce' ), ), ), 'GB' => array( 'postcode' => array( 'label' => __( 'Postcode', 'woocommerce' ), ), 'state' => array( 'label' => __( 'County', 'woocommerce' ), 'required' => false, ), ), 'VN' => array( 'state' => array( 'required' => false, ), 'postcode' => array( 'priority' => 65, 'required' => false, 'hidden' => false, ), 'address_2' => array( 'required' => false, 'hidden' => true, ), ), 'WS' => array( 'postcode' => array( 'required' => false, 'hidden' => true, ), ), 'YT' => array( 'state' => array( 'required' => false, ), ), 'ZA' => array( 'state' => array( 'label' => __( 'Province', 'woocommerce' ), ), ), 'ZW' => array( 'postcode' => array( 'required' => false, 'hidden' => true, ), ), )
The array.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'woocommerce_get_country_locale', $array ); 
  2.  
  3. if ( !empty( $array ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_get_country_locale callback 
  2. function filter_woocommerce_get_country_locale( $array ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_get_country_locale', 'filter_woocommerce_get_country_locale', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_get_country_locale', 'filter_woocommerce_get_country_locale', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/class-wc-countries.php  
  1. $this->locale = apply_filters( 'woocommerce_get_country_locale', array(