PHP: Hypertext Preprocessor (original) (raw)

mysqli::set_charset

mysqli_set_charset

(PHP 5 >= 5.0.5, PHP 7, PHP 8)

mysqli::set_charset -- mysqli_set_charset — Sets the client character set

Description

Object-oriented style

public mysqli::set_charset(string $charset): bool

Return Values

Returns [true](reserved.constants.php#constant.true) on success or [false](reserved.constants.php#constant.false) on failure.

Examples

Example #1 mysqli::set_charset() example

Object-oriented style

`<?php

mysqli_report

(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT); mysqli=newmysqli("localhost","myuser","mypassword","test");printf("Initialcharacterset:mysqli = new mysqli("localhost", "my_user", "my_password", "test");printf("Initial character set: %s\n", mysqli=newmysqli("localhost","myu​ser","myp​assword","test");printf("Initialcharacterset:mysqli->character_set_name());/* change character set to utf8mb4 */ mysqli−>setcharset("utf8mb4");printf("Currentcharacterset:mysqli->set_charset("utf8mb4");printf("Current character set: %s\n", mysqli−>setc​harset("utf8mb4");printf("Currentcharacterset:mysqli->character_set_name());`

Procedural style

`<?php

mysqli_report

(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT); link=mysqliconnect(′localhost′,′myuser′,′mypassword′,′test′);printf("Initialcharacterset:link = mysqli_connect('localhost', 'my_user', 'my_password', 'test');printf("Initial character set: %s\n", mysqli_character_set_name(link=mysqlic​onnect(′localhost′,′myu​ser′,′myp​assword′,′test′);printf("Initialcharacterset:link));/* change character set to utf8mb4 */
mysqli_set_charset($link, "utf8mb4");printf("Current character set: %s\n", mysqli_character_set_name($link));`

The above examples will output something similar to:

Initial character set: latin1 Current character set: utf8mb4

See Also

Found A Problem?

Konstantin Rozinov

7 years ago

`The comment by Claude (http://php.net/manual/en/mysqli.set-charset.php#121067) is CORRECT.

Setting the charset (it's really the encoding) like this after setting up your connection:
$connection->set_charset("utf8mb4")

FAILS to set the proper collation for the connection:

character_set_client: utf8mb4
character_set_connection: utf8mb4
character_set_database: utf8mb4
character_set_filesystem: binary
character_set_results: utf8mb4
character_set_server: utf8mb4
character_set_system: utf8
collation_connection: utf8mb4_general_ci <---- still says general
collation_database: utf8mb4_unicode_ci
collation_server: utf8mb4_unicode_ci

If you use SET NAMES, that works:
$connection->query("SET NAMES utf8mb4 COLLATE utf8mb4_unicode_ci");

character_set_client: utf8mb4
character_set_connection: utf8mb4
character_set_database: utf8mb4
character_set_filesystem: binary
character_set_results: utf8mb4
character_set_server: utf8mb4
character_set_system: utf8
collation_connection: utf8mb4_unicode_ci <-- now says unicode
collation_database: utf8mb4_unicode_ci
collation_server: utf8mb4_unicode_ci

Please note, that I set the following variables on the server:

Set the following to be: utf8mb4_unicode_ci

character_set_client
character_set_connection
character_set_database
character_set_results
character_set_server

collation_connection
collation_server

Set:

character-set-client-handshake = FALSE or 0
skip-character-set-client-handshake = TRUE or 1

`

Emmanuel Appiah

9 years ago

`` So in my case, I had tried changing the collation from utf8mb4_unicode_ci for mysql and had to change it to uft8_general_ci.

Then pasted :

mysqli_set_charset( $con, 'utf8');

right before I did the SELECT command.

This is my code for reading from db :

/*

$DB_SERVER="db_server_name";
$DB_USER_READER="root";
$DB_PASS_READER="passw*rd";
$DB_NAME="db_name";
$DB_PORT="port number";

$SELECT_WHAT="name_of_column_as_in_your_table";
$WHICH_TBL="table_name";
$ON_WHAT_CONDITION="id='7'";

*/ con=mysqliconnect(con = mysqli_connect(con=mysqlic​onnect(DB_SERVER, DBUSERREADER,DB_USER_READER, DBU​SERR​EADER,DB_PASS_READER, DBNAME,DB_NAME, DBN​AME,DB_PORT);//this is the unique connection for the selection

mysqli_set_charset( $con, 'utf8');

slctstmnt="SELECT".slct_stmnt = "SELECT ".slcts​tmnt="SELECT".SELECT_WHAT." FROM ".$WHICH_TBL." WHERE ".$ON_WHAT_CONDITION;

slctquery=mysqliquery(slct_query = mysqli_query(slctq​uery=mysqliq​uery(con, $slct_stmnt);

if ($slct_query==true) {
//Do your stuff here . . .
}

And it worked like a charm. All the best. The above code can work with reading chineese, russian or arabic or any international language from the database's table column holding such data.

``

claude dot pache at gmail dot com

7 years ago

`Although the documentation says that using that function is preferred than using SET NAMES, it is not sufficient in case you use a collation different from the default one:

set_charset('latin1');// You have to execute the following statement *after* mysqli::set_charset() // in order to get the desired value for collation_connection: $mysqli->query("SET NAMES latin1 COLLATE latin1_german1_ci"); ` [ **_ASchmidt at Anamera dot net_**](#122858)[ ¶](#122858) **6 years ago** `To align both the character set (e.g., utf8mb4) AND the collation sequence with the schema (database) settings: connect_errno ) throw new \Exception( mysqli−>connecterror,mysqli->connect_error, mysqli−>connecte​rror,mysqli->connect_errno ); if ( TRUE !== $mysqli->set_charset( 'utf8mb4' ) ) throw new \Exception( mysql−>error,mysql->error, mysql−>error,mysqli->errno ); if ( TRUE !== $mysqli->query( 'SET collation_connection = @@collation_database;' ) ) throw new \Exception( mysql−>error,mysql->error, mysql−>error,mysqli->errno ); ?>

To confirm:

character_set_name(), '
', PHP_EOL; foreach( mysqli−>query("SHOWVARIABLESLIKE′mysqli->query( "SHOW VARIABLES LIKE '%_connection';" )->fetch_all() as mysqli−>query("SHOWVARIABLESLIKE′setting ) echo setting[0],′:′,setting[0], ': ', setting[0],′:′,setting[1], '
', PHP_EOL; ?>

will output something like:
character_set_name: utf8mb4
character_set_connection: utf8mb4
collation_connection: utf8mb4_unicode_520_ci

`

chris at ocproducts dot com

7 years ago

`Note that using utf8mb4 with this function may cause this function to return false, depending on the MySQL client library compiled into PHP. If the client library is older than the introduction of utf8mb4, then PHP's call of the libraries 'mysql_set_character_set' will return an error because it won't recognise that character set.

The only way you will know there's an error is by checking the return value, because PHP warnings are not emitted by this function.
mysqli_error will return something like:
"Can't initialize character set utf8mb4 (path: /usr/share/mysql/charsets/)"
(I don't think the directory has anything to do with it; I think the utf8mb4 vs utf8 distinction is handled internally)

A workaround is to recall with utf8, then do a 'SET NAMES' query with utf8mb4.

If your MySQL server is configured to use utf8 by default, then you may not notice any of this until you get obscure bugs. It seems it will still save into the database correctly in terms of bytes. However, you may get "Data too long for column" errors if you are truncating strings to fit fields, because from MySQL's point of view during the length check every 4-byte character will actually be multiple individual characters. This caused me hours of debugging.

`