Home/ Manual/ intl / locale/ Locale::getDisplayVariant

Locale::getDisplayVariant

PHP function Edit on GitHub ✎

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

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

Description

Oop

Locale::getDisplayVariant(string $locale, string|null $displayLocale = null): string|false

Procedural

locale_get_display_variant(string $locale, string|null $displayLocale = null): string|false

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

Parameters

locale: The locale to return a display variant for
displayLocale: Optional format locale to use to display the variant name

Return Values

Display name of the variant for the locale in the format appropriate for displayLocale, Falseforfailure.

Changelog

Version	Description
8.0.0	`displayLocale` is nullable now.

Examples

locale_get_display_variant() example

php

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

OO example

php

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

The above example will output:

output

Natisone dialect;
dialecte de Natisone;
NEDIS