Locale::getDisplayRegion

locale_get_display_region

Returns an appropriately localized display name for region of the input locale

Description

Object-oriented style

public static stringfalse Locale::getDisplayRegion(string $locale, stringnull $displayLocale = null)

Procedural style

stringfalse locale_get_display_region(string $locale, stringnull $displayLocale = null)

Returns an appropriately localized display name for region of the input locale. If is null then the default locale is used.

Parameters

locale

The locale to return a display region for.

displayLocale

Optional format locale to use to display the region name

Return Values

Display name of the region for the locale in the format appropriate for displayLocale, or false on failure.

Changelog

Version Description
8.0.0 displayLocale is nullable now.

Examples

Example #1 locale_get_display_region example

<?php
echo locale_get_display_region('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo locale_get_display_region('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo locale_get_display_region('sl-Latn-IT-nedis', 'de');
?>

Example #2 OO example

<?php
echo Locale::getDisplayRegion('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo Locale::getDisplayRegion('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo Locale::getDisplayRegion('sl-Latn-IT-nedis', 'de');
?>

The above example will output:

Italy;
Italie;
Italien

See Also

  • locale_get_display_name
  • locale_get_display_language
  • locale_get_display_script
  • locale_get_display_variant