<!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>Detect character encoding</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mb-decode-numericentity.html">mb_decode_numericentity</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-detect-order.html">mb_detect_order</a></div>
<div class="up"><a href="ref.mbstring.html">Multibyte String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mb-detect-encoding" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_detect_encoding</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">mb_detect_encoding</span> — <span class="dc-title">Detect character encoding</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mb-detect-encoding-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>mb_detect_encoding</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></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">$encoding_list</code><span class="initializer"> = mb_detect_order()</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$strict</code><span class="initializer"> = false</span></span>
]] )</div>
<p class="para rdfs-comment">
Detects character encoding in <span class="type"><a href="language.types.string.html" class="type string">string</a></span> <em><code class="parameter">str</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mb-detect-encoding-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">str</code></em></span>
<dd>
<p class="para">
The <span class="type"><a href="language.types.string.html" class="type string">string</a></span> being detected.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">encoding_list</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">encoding_list</code></em> is list of character
encoding. Encoding order may be specified by array or comma
separated list string.
</p>
<p class="para">
If <em><code class="parameter">encoding_list</code></em> is omitted,
detect_order is used.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">strict</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">strict</code></em> specifies whether to use
the strict encoding detection or not.
Default is <strong><code>FALSE</code></strong>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mb-detect-encoding-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The detected character encoding or <strong><code>FALSE</code></strong> if the encoding cannot be
detected from the given string.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mb-detect-encoding-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2705">
<p><strong>Example #1 <span class="function"><strong>mb_detect_encoding()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Detect character encoding with current detect_order */<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">mb_detect_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* "auto" is expanded according to mbstring.language */<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">mb_detect_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #DD0000">"auto"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Specify encoding_list character encoding by comma separated list */<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">mb_detect_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #DD0000">"JIS, eucjp-win, sjis-win"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Use array to specify encoding_list */<br /></span><span style="color: #0000BB">$ary</span><span style="color: #007700">[] = </span><span style="color: #DD0000">"ASCII"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$ary</span><span style="color: #007700">[] = </span><span style="color: #DD0000">"JIS"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$ary</span><span style="color: #007700">[] = </span><span style="color: #DD0000">"EUC-JP"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">mb_detect_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">$ary</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.mb-detect-encoding-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.mb-detect-order.html" class="function" rel="rdfs-seeAlso">mb_detect_order()</a> - Set/Get character encoding detection order</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="function.mb-decode-numericentity.html">mb_decode_numericentity</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-detect-order.html">mb_detect_order</a></div>
<div class="up"><a href="ref.mbstring.html">Multibyte String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
