<!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 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-convert-case.html">mb_convert_case</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-convert-kana.html">mb_convert_kana</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-convert-encoding" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_convert_encoding</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">mb_convert_encoding</span> — <span class="dc-title">Convert character encoding</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mb-convert-encoding-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>mb_convert_encoding</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$to_encoding</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">$from_encoding</code><span class="initializer"> = mb_internal_encoding()</span></span>
] )</div>
<p class="para rdfs-comment">
Converts the character encoding of <span class="type"><a href="language.types.string.html" class="type string">string</a></span> <em><code class="parameter">str</code></em>
to <em><code class="parameter">to_encoding</code></em>
from optionally <em><code class="parameter">from_encoding</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mb-convert-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 encoded.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">to_encoding</code></em></span>
<dd>
<p class="para">
The type of encoding that <em><code class="parameter">str</code></em> is being converted to.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">from_encoding</code></em></span>
<dd>
<p class="para">
Is specified by character code names before conversion. It is either
an <span class="type"><a href="language.types.array.html" class="type array">array</a></span>, or a comma separated enumerated list.
If <em><code class="parameter">from_encoding</code></em> is not specified, the internal
encoding will be used.
</p>
<p class="para">
See <a href="mbstring.supported-encodings.html" class="link">supported
encodings</a>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mb-convert-encoding-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The encoded <span class="type"><a href="language.types.string.html" class="type string">string</a></span>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mb-convert-encoding-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2701">
<p><strong>Example #1 <span class="function"><strong>mb_convert_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">/* Convert internal character encoding to SJIS */<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #DD0000">"SJIS"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Convert EUC-JP to UTF-7 */<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #DD0000">"UTF-7"</span><span style="color: #007700">, </span><span style="color: #DD0000">"EUC-JP"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Auto detect encoding from JIS, eucjp-win, sjis-win, then convert str to UCS-2LE */<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #DD0000">"UCS-2LE"</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">/* "auto" is expanded to "ASCII,JIS,UTF-8,EUC-JP,SJIS" */<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #DD0000">"EUC-JP"</span><span style="color: #007700">, </span><span style="color: #DD0000">"auto"</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-convert-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-convert-case.html">mb_convert_case</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-convert-kana.html">mb_convert_kana</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>
