IntlChar::charName
(PHP 7, PHP 8)
IntlChar::charName — Retrieve the name of a Unicode character
Description
$codepoint, int $type = IntlChar::UNICODE_CHAR_NAME): ?stringRetrieves the name of a Unicode character.
Depending on type, the resulting character name is the "modern" name or the name that
was defined in Unicode version 1.0. The name contains only "invariant" characters like A-Z, 0-9, space, and '-'.
Unicode 1.0 names are only retrieved if they are different from the modern names and if ICU contains the data for them.
Parameters
-
codepoint -
The int codepoint value (e.g.
0x2603for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g."\u") -
type -
Which set of names to use for the lookup. Can be any of these constants:
IntlChar::UNICODE_CHAR_NAME(default)IntlChar::UNICODE_10_CHAR_NAMEIntlChar::EXTENDED_CHAR_NAMEIntlChar::CHAR_NAME_ALIASIntlChar::CHAR_NAME_CHOICE_COUNT
Return Values
The corresponding name, or an empty string if there is no name for this character,
or null if there is no such code point.
Examples
Example #1 Testing different code points
<?php
var_dump(IntlChar::charName("."));
var_dump(IntlChar::charName(".", IntlChar::UNICODE_CHAR_NAME));
var_dump(IntlChar::charName("\u"));
var_dump(IntlChar::charName("\u"));
?>
The above example will output:
string(9) "FULL STOP" string(9) "FULL STOP" string(7) "SNOWMAN" string(0) ""
See Also
- IntlChar::charFromName() - Find Unicode character by name and return its code point value
- IntlChar::enumCharNames() - Enumerate all assigned Unicode characters within a range
