<!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>Convert the first byte of a string to a value between 0 and 255</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.number-format.html">number_format</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.parse-str.html">parse_str</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ord" class="refentry">
<div class="refnamediv">
<h1 class="refname">ord</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">ord</span> — <span class="dc-title">Convert the first byte of a string to a value between 0 and 255</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ord-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ord</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$string</code></span>
)</div>
<p class="para rdfs-comment">
Interprets the binary value of the first byte of
<code class="parameter">string</code> as an unsigned integer between 0 and 255.
</p>
<p class="para">
If the string is in a single-byte encoding, such as ASCII, ISO-8859, or Windows 1252, this is equivalent to returning the position of a character in the character set's mapping table. However, note that this function is not aware of any string encoding, and in particular will never identify a Unicode code point in a multi-byte encoding such as UTF-8 or UTF-16.
</p>
<p class="para">
This function complements <span class="function"><a href="function.chr.html" class="function">chr()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ord-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">string</code></dt>
<dd>
<p class="para">
A character.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ord-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An integer between 0 and 255.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ord-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-6058">
<p><strong>Example #1 <span class="function"><strong>ord()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$str </span><span style="color: #007700">= </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">ord</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">) == </span><span style="color: #0000BB">10</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"The first character of \$str is a line feed.\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-6059">
<p><strong>Example #2 Examining the individual bytes of a UTF-8 string</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">declare(</span><span style="color: #0000BB">encoding</span><span style="color: #007700">=</span><span style="color: #DD0000">'UTF-8'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #DD0000">"🐘"</span><span style="color: #007700">;<br />for ( </span><span style="color: #0000BB">$pos</span><span style="color: #007700">=</span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$pos </span><span style="color: #007700">< </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">); </span><span style="color: #0000BB">$pos </span><span style="color: #007700">++ ) {<br /> </span><span style="color: #0000BB">$byte </span><span style="color: #007700">= </span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">$pos</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">'Byte ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$pos </span><span style="color: #007700">. </span><span style="color: #DD0000">' of $str has value ' </span><span style="color: #007700">. </span><span style="color: #0000BB">ord</span><span style="color: #007700">(</span><span style="color: #0000BB">$byte</span><span style="color: #007700">) . </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />}<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"><br />
Byte 0 of $str has value 240<br />
Byte 1 of $str has value 159<br />
Byte 2 of $str has value 144<br />
Byte 3 of $str has value 152<br />
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ord-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.chr.html" class="function" rel="rdfs-seeAlso">chr()</a> - Generate a single-byte string from a number</span></li>
<li class="member">An <a href="http://www.asciitable.com" class="link external">» ASCII-table</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.number-format.html">number_format</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.parse-str.html">parse_str</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
