Tell me more ×
Stack Overflow is a question and answer site for professional and enthusiast programmers. It's 100% free, no registration required.

I'm setting up a new server, and want to support UTF-8 fully in my web application. I have tried in the past on existing servers and always seem to end up having to fall back to ISO-8859-1.

Where exactly do I need to set the encoding/charsets? I'm aware that I need to configure Apache, MySQL and PHP to do this - is there some standard checklist I can follow, or perhaps troubleshoot where the mismatches occur?

This is for a new Linux server, running MySQL 5, PHP 5 and Apache 2.

share|improve this question
 
Here is an overview about all encoding faults you can possibly make: sebastianviereck.de/en/… –  slaver113 Jan 27 at 10:29
 
Here's an introduction to encodings in general and encodings in PHP in particular: What Every Programmer Absolutely, Positively Needs To Know About Encodings And Character Sets To Work With Text –  deceze Jul 9 at 19:33
add comment

11 Answers

up vote 217 down vote accepted

Data Storage:

  • Specify the utf8 character set on all tables and text columns in your database. This makes MySQL physically store and retrieve values encoded natively in UTF-8. Note that MySQL will implicitly use utf8 encoding if a utf8_* collation is specified (without any explicit character set).
  • The MySQL utf8 encoding is only a subset of actual UTF-8, supporting only the BMP. MySQL 5.5 and higher support utf8mb4, which is "real" UTF-8 and should be preferred if supported.

Data Access:

  • In your application code (e.g. PHP), in whatever DB access method you use, you'll need to set the connection charset to utf8. This way, MySQL does no conversion from its native UTF-8 when it hands data off to your application and vice versa.

  • Some drivers provide their own mechanism for configuring the connection character set, which both updates its own internal state and informs MySQL of the encoding to be used on the connection—this is usually the preferred approach. In PHP:

    • If you're using the PDO abstraction layer with PHP ≥ 5.3.6, you can specify charset in the DSN:

      $dbh = new PDO('mysql:charset=utf8');
      
    • If you're using mysqli, you can call set_charset():

      $mysqli->set_charset('utf8');       // object oriented style
      mysqli_set_charset($link, 'utf8');  // procedural style
      
  • If the driver does not provide its own mechanism for setting the connection character set, you may have to issue a query to tell MySQL how your application expects data on the connection to be encoded: SET NAMES 'utf8'.

  • The same consideration regarding utf8/utf8mb4 applies as above.

Output:

  • If your application transmits text to other systems, they will also need to be informed of the character encoding. With web applications, the browser must be informed of the encoding in which data is sent (through HTTP response headers or HTML metadata).

  • In PHP, you can use the default_charset php.ini option, or manually issue the Content-Type MIME header yourself, which is just more work but has the same effect.

Input:

  • Unfortunately, you should verify every received string as being valid UTF-8 before you try to store it or use it anywhere. PHP's mb_check_encoding() does the trick, but you have to use it religiously. There's really no way around this, as malicious clients can submit data in whatever encoding they want, and I haven't found a trick to get PHP to do this for you reliably.

  • From my reading of the current HTML spec, the following sub-bullets are not necessary or even valid anymore for modern HTML. My understanding is that browsers will work with and submit data in the character set specified for the document. However, if you're targeting older versions of HTML (XHTML, HTML4, etc.), these points may still be useful:

    • For HTML before HTML5 only: you want all data sent to you by browsers to be in UTF-8. Unfortunately, if you go by the the only way to reliably do this is add the accept-charset attribute to all your <form> tags: <form ... accept-charset="UTF-8">.
    • For HTML before HTML5 only: note that the W3C HTML spec says that clients "should" default to sending forms back to the server in whatever charset the server served, but this is apparently only a recommendation, hence the need for being explicit on every single <form> tag.

Other Code Considerations:

  • Obviously enough, all files you'll be serving (PHP, HTML, JavaScript, etc.) should be encoded in valid UTF-8.
  • You need to make sure that every time you process a UTF-8 string, you do so safely. This is, unfortunately, the hard part. You'll probably want to make extensive use of PHP's mbstring extension.
  • PHP's built-in string operations are not by default UTF-8 safe. There are some things you can safely do with normal PHP string operations (like concatenation), but for most things you should use the equivalent mbstring function.
  • To know what you're doing (read: not mess it up), you really need to know UTF-8 and how it works on the lowest possible level. Check out any of the links from utf8.com for some good resources to learn everything you need to know.
share|improve this answer
1  
collation is not the same as encoding. Be sure to set the encoding to utf8, in your database. Collation is less important. –  troelskn Nov 10 '08 at 21:47
 
It's my understanding that if you specify the collation as utf8_*, it automatically encodes as utf8 as well. Is this wrong? –  chazomaticus Nov 10 '08 at 21:49
20  
I'm not wrong: COLLATE implies CHARACTER SET. See e.g. dev.mysql.com/doc/refman/5.0/en/charset-database.html. –  chazomaticus Nov 10 '08 at 23:01
2  
Consider adding PDO examples for setting the character set as well. –  Jack Oct 22 '12 at 3:35
8  
Note that MySQL does not speak the same language as everyone else. When MySQL says "utf8" it really means "some weirdly retarded variant of UTF-8 that is limited to three bytes for god knows what ridiculous reason". If you really want UTF-8 you should tell MySQL that you want this weird thing MySQL likes to call utf8mb4. Don't bother saving on the "WTF!"s. –  R. Martinho Fernandes Apr 9 at 9:21
show 4 more comments

I'd like to add one thing to chazomaticus' excellent answer:

Don't forget the META tag either (like this, or the HTML4 or XHTML version of it):

<meta charset="utf-8">

That seems trivial, but IE7 has given me problems with that before.

I was doing everything right; the database, database connection and Content-Type HTTP header were all set to UTF-8, and it worked fine in all other browsers, but Internet Explorer still insisted on using the "Western European" encoding.

It turned out the page was missing the META tag. Adding that solved the problem.

Edit:

The W3C actually has a rather large section dedicated to I18N. They have a number of articles related to this issue – describing the HTTP, (X)HTML and CSS side of things:

They recommend using both the HTTP header and HTML meta tag (or XML declaration in case of XHTML served as XML).

share|improve this answer
 
Shouldn't it also be possible to specify the charset in the HTTP headers? Probably needs some config option for the webserver... –  oliver Nov 20 '08 at 17:47
 
@oliver: Yes you can send it in the HTTP header, but it's better to send it in the content because if the client saves the file, it'll always save the meta tag. A HTTP header is likely to just disappear unless the browser is smart enough to copy it into a meta tag in the saved file. –  flussence Dec 2 '08 at 1:49
1  
Also, make sure that line is the first child of head element (before any Unicode stuff). The browser may reinterpret the page after hitting that meta element described above. –  alex Apr 20 '10 at 8:55
add comment

In addition to setting default_charset in php.ini, you can send the correct charset using header() from within your code, before any output:

header('Content-Type: text/html; charset=utf-8');

Working with Unicode in PHP is easy as long as you realize that most of the string functions don't work with Unicode, and some might mangle strings completely. PHP considers "characters" to be 1 byte long. Sometimes this is okay (for example, explode() only looks for a byte sequence and uses it as a separator -- so it doesn't matter what actual characters you look for). But other times, when the function is actually designed to work on characters, PHP has no idea that your text has multi-byte characters that are found with Unicode.

A good library to check into is phputf8. This rewrites all of the "bad" functions so you can safely work on UTF8 strings. There are extensions like the mbstring extension that try to do this for you, too, but I prefer using the library because it's more portable (but I write mass-market products, so that's important for me). But phputf8 can use mbstring behind the scenes, anyway, to increase performance.

share|improve this answer
add comment

Old topic, I know. Found an issue with someone using PDO and the answer was to use this for the PDO Connection string:

$pdo = new PDO(
    'mysql:host=mysql.example.com;dbname=example_db',
    "username",
    "password",
    array(PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES utf8"));

The site I took this from is down, was able to get it using google cache luckily.

Hope it helps someone!

share|improve this answer
add comment

In my case, I was using mb_split, which uses regex. Therefore I also had to manually make sure the regex encoding was utf-8 by doing mb_regex_encoding('UTF-8');

As a side note, I also discovered by running mb_internal_encoding() that the internal encoding wasn't utf-8, and I changed that by running mb_internal_encoding("UTF-8");.

share|improve this answer
add comment

Good goal to have from the start - based on the nature of your site, I've found lots of resources about this by Googling - you're not the first to deal with it, of course.

The mystical PHP6 is supposed to have all this straightened out, right?

You can pretty much set utf-8 as the global default charset for mysql at the server level and it will default properly to the more granular levels.

share|improve this answer
add comment

Unicode support in PHP is still a huge mess. While it's capable of converting an ISO8859 string (which it uses internally) to utf8, it lacks the capability to work with unicode strings natively, which means all the string processing functions will mangle and corrupt your strings. So you have to either use a separate library for proper utf8 support, or rewrite all the string handling functions yourself.

The easy part is just specifying the charset in HTTP headers and in the databsae and such, but none of that matters if your PHP code doesn't output valid UTF8. That's the hard part, and PHP gives you virtually no help there. (I think PHP6 is supposed to fix the worst of this, but that's still a while away)

share|improve this answer
add comment

The top answer is excellent. Here is what I had to on a regular debian/php/mysql setup:

// storage
// debian. apparently already utf-8

// retrieval
// the mysql database was stored in utf-8, 
// but apparently php was requesting iso. this worked: 
// ***notice "utf8", without dash, this is a mysql encoding***
mysql_set_charset('utf8');

// delivery
// php.ini did not have a default charset, 
// (it was commented out, shared host) and
// no http encoding was specified in the apache headers.
// this made apache send out a utf-8 header
// (and perhaps made php actually send out utf-8)
// ***notice "utf-8", with dash, this is a php encoding***
ini_set('default_charset','utf-8');

// submission
// this worked in all major browsers once apache
// was sending out the utf-8 header. i didnt add
// the accept-charset attribute.

// processing
// changed a few commands in php, like substr,
// to mb_substr

that was all !

share|improve this answer
add comment

In PHP, you'll need to either use the multibyte functions, or turn on mbstring.func_overload. That way things like strlen will work if you have characters that take more than one byte.

You'll also need to identify the character set of your responses. You can either use AddDefaultCharset, as above, or write PHP code that returns the header. (Or you can add a META tag to your HTML documents.)

share|improve this answer
add comment

As far as I know, UTF8 is the standard encoding for php's internals. What does matter though is the charset in the headers sent by the server.

In the php.ini file, there must be something like default_charset, which sets the default encoding in the headers.

For apache 2.0 , you can specify AddDefaultCharset in the httpd.conf.

And for MySQL, the encoding is specified on four different levels, so you must verify all four (server, database, table, and column) of them.

share|improve this answer
2  
It's not. But it will be from php 6 –  troelskn Nov 10 '08 at 21:48
add comment

if you're too lazy to do those written above... you could just create your tables as you wish and make your forms accept their default browser set encodings then use this function to parse all inputs

foreach($_POST as $varname => $value) {
   $$varname = utf8_decode(clean($value));
}
share|improve this answer
add comment

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.