Methods

• ias_cntrs_get_country_code ( $country, $lang )

  Get country code for exactly given country name

  'lang' - optional.

• ias_cntrs_search_country_code ( $country_code, $lang )

  Find all matches of country code by giving country name (or part of it)

  'lang' - optional.

• ias_cntrs_get_country_slug ( $country_code )

  Get url compatible name of country ( $slug )

• ias_cntrs_get_country_by_code ( $country_code, $lang )

  Get country name by its ISO code

  'lang' - optional. If language not defined, country returned in default language from built-in translation version.

• ias_cntrs_get_country_by_slug ( $slug, $lang )

  Get country name by its slug (url compatible name)

  For predefined country slugs look into plugin subfolder /assets/xml/default.xml or database table 'ias_cntrs_table_base'

  'lang' - optional.

• ias_cntrs_get_countries_by_region ( $region, $lang )

  Get countries of given region

  'lang' - optional. If language not defined, countries returned in default language from built-in translation version.

• ias_cntrs_get_selection ( $selection_id, $lang )

  Get countries of the given selection

  See bellow for parameter description.

  'lang' - optional. If language not defined, countries returned in default language from built-in translation version.

• ias_cntrs_get_translations ( $include )

  Get all available translations for the given set of countries

  See bellow for parameter description.

• ias_cntrs_get_translated_countries ( $lang )

  Get only translated terms for the given language

• ias_cntrs_get_countries ( $args )

  Get countries according to given arguments

  Parameters

  $args = array(
  	'lang' => null,
  	'include' => null,
  	'exclude' => null,
  	'selection' => null,
  	'region' => null,
  	'orderby' => 'name',
  	'order' => 'ASC',
  	'fallback' => false,
  	'incl_empty' => true
  );

  • 'lang' - (string/array) (optional) two-letter language codes, e.g., 'en' or array('de', 'fr')
    • If 'lang' is defined as array of one language and fallback is true, each country returns a numeric array of country name in default language of built-in translation version (always available) and available custom translation (empty string if nothing).
    • If 'lang' left undefined, countries are listed in default language of built-in translation version.
  • 'include', 'exclude' - (string/array) (optional) of country codes to include/exclude
  • 'selection' - (int) (optional) id of custom country selection
  • 'region' - (string/array) (optional) of regions to include. Accepted region parameters:
    • 'africa' for Africa,
    • 'antarctica' for Antarctica,
    • 'asiapacific' for Asia with Pacific Islands including Australia,
    • 'europe' for Europe,
    • 'northamerica' for North America,
    • 'southamerica' for South America.
    • Following countries are part of both Asia and Europe: Armenia, Azerbaijan, Georgia, Kazakhstan, Russia, Turkey
  • 'orderby' - (string) (optional) values accepted:
    • 'code' - order by country ISO code,
    • 'name' - order by country name
  • 'order' - (string) (optional) values accepted 'ASC', 'DESC'
  • 'fallback' - (boolean true/false) (optional) replace empty translations with built-in translation of default language
  • 'incl_empty' - (boolean true/false) (optional) include countries with no translation for the given language; effective only in case of one language. This parameter is automatically set to true if 'fallback' parameter is true (every empty translation will be replaced by default value).
• ias_cntrs_get_dropdown ( $header, $args )

  Return drop-down list

  Parameters

  $args = array(
  	// input field specific
  	'name' => 'country',
  	'id' => '',
  	'class' => '',
  	'selected' => array(),
  	'multiple' => false,
  	'top' => array(), 
  	// country specific (see above)
  	'lang' => null,
  	'include' => null,
  	'exclude' => null,
  	'selection' => null,
  	'region' => null,
  	'orderby' => 'name',
  	'order' => 'ASC',
  	'fallback' => false
  );

  • 'header' - (string) (optional) label for the blank option at the head of the drop-down list, e.g. __('Select country', 'your-text-domain'). If this parameter is empty string, drop-down list starts immediately with countries.
  • 'multiple' - (boolean true/false) (optional) multiple selection enabled
  • 'top' - (array) (optional) countries to be shown on top of the list, array of country ISO codes
  • 'lang' - (string) (optional) one language accepted only. If language not defined, countries returned in default language from built-in translation version.
• ias_cntrs_dropdown ( $header, $args )

  Echo drop-down list

Use

if(function_exists('ias_cntrs_get_countries')){
	$args = array(
		'lang' => 'de',
		'include' => array('DE', 'FR', 'AT')
	);
	$countries = ias_cntrs_get_countries($args);
}

Filters

ias_cntrs_languages_list

Filter list of languages offered for custom translation

Use

Add to functions.php

if(class_exists('iasCountries')){
	add_filter('ias_cntrs_languages_list', 'my_langs');
	function my_langs($languages){
		$languages['ho'] = 'Hiri Motu';
		ksort($languages);
		return $languages;
	}
}

Add new languages in accordance with ISO 639-1 codes.

Import

Formats accepted for translation import: xml, csv.

CSV format

...
AW:Aruba
AU:Australia
...

...
AW;Aruba
AU;Australia
...

XML format

<?xml version="1.0" encoding="UTF-8"?>
	<countries xml:id="en">
		...
		<AW>Aruba</AW>
		<AU>Australia</AU>
		...
	</countries>