<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Retrieve the name of a Unicode character</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlchar.charmirror.html">IntlChar::charMirror</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlchar.chartype.html">IntlChar::charType</a></div>
<div class="up"><a href="class.intlchar.html">IntlChar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="intlchar.charname" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlChar::charName</h1>
<p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">IntlChar::charName</span> — <span class="dc-title">Retrieve the name of a Unicode character</span></p>
</div>
<div class="refsect1 description" id="refsect1-intlchar.charname-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><strong>IntlChar::charName</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$codepoint</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$nameChoice</code><span class="initializer"> = <strong><code>IntlChar::UNICODE_CHAR_NAME</code></strong></span></span>
] )</div>
<p class="para rdfs-comment">
Retrieves the name of a Unicode character.
</p>
<p class="para">
Depending on <code class="parameter">nameChoice</code>, 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.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intlchar.charname-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">codepoint</code></dt>
<dd>
<p class="para">The <span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span> codepoint value (e.g. <em>0x2603</em> for <em class="emphasis">U+2603 SNOWMAN</em>), or the character encoded as a UTF-8 <span class="type"><a href="language.types.string.html" class="type string">string</a></span> (e.g. <em>"\u{2603}"</em>)</p>
</dd>
<dt>
<code class="parameter">nameChoice</code></dt>
<dd>
<p class="para">
Which set of names to use for the lookup. Can be any of these constants:
<ul class="simplelist">
<li class="member"><strong><code>IntlChar::UNICODE_CHAR_NAME</code></strong> (default)</li>
<li class="member"><strong><code>IntlChar::UNICODE_10_CHAR_NAME</code></strong></li>
<li class="member"><strong><code>IntlChar::EXTENDED_CHAR_NAME</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_NAME_ALIAS</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_NAME_CHOICE_COUNT</code></strong></li>
</ul>
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-intlchar.charname-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The corresponding name, or an empty string if there is no name for this character.
</p>
</div>
<div class="refsect1 examples" id="refsect1-intlchar.charname-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3197">
<p><strong>Example #1 Testing different code points</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">charName</span><span style="color: #007700">(</span><span style="color: #DD0000">"."</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">charName</span><span style="color: #007700">(</span><span style="color: #DD0000">"."</span><span style="color: #007700">, </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">UNICODE_CHAR_NAME</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">charName</span><span style="color: #007700">(</span><span style="color: #DD0000">"\u{2603}"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">charName</span><span style="color: #007700">(</span><span style="color: #DD0000">"\u{0000}"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(9) "FULL STOP"
string(9) "FULL STOP"
string(7) "SNOWMAN"
string(0) ""
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-intlchar.charname-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="intlchar.charfromname.html" class="function" rel="rdfs-seeAlso">IntlChar::charFromName()</a> - Find Unicode character by name and return its code point value</span></li>
<li class="member"><span class="function"><a href="intlchar.enumcharnames.html" class="function" rel="rdfs-seeAlso">IntlChar::enumCharNames()</a> - Enumerate all assigned Unicode characters within a range</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlchar.charmirror.html">IntlChar::charMirror</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlchar.chartype.html">IntlChar::charType</a></div>
<div class="up"><a href="class.intlchar.html">IntlChar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
