PHP mysqli: get_charset() function

Last update on August 19 2022 21:50:40 (UTC/GMT +8 hours)

mysqli_get_charset() function / mysqli::get_charset

The mysqli_get_charset() function / mysqli::get_charset returns a character set object.

Syntax:

Object oriented style

object mysqli::get_charset ( void )

Procedural style

object mysqli_get_charset ( mysqli $link )

Parameter:

Name	Description	Required/Optional
link	A link identifier returned by mysqli_connect() or mysqli_init()	Required for procedural style only and Optional for Object oriented style

Usage: Procedural style

mysqli_get_charset(connection);

Parameter:

Name	Description	Required/Optional
connection	Specifies the MySQL connection to use.	Required

Return value:

The function returns a character set object with the following properties:

Name	Description
charset	Character set name
collation	Collation name
dir	Directory the charset description was fetched from (?) or "" for built-in character sets
min_length	Minimum character length in bytes
max_length	Maximum character length in bytes
number	Internal character set number
state	Character set status (?)

Version: PHP 5, PHP 7

Example of object oriented style:

<?php
 $db = mysqli_init();
  $db->real_connect("localhost","user1","datasoft123","hr");
  var_dump($db->get_charset());
?>

Output:

object(stdClass)#3 (8) { ["charset"]=> string(6) "latin1" ["collation"]=> string(17) "latin1_swedish_ci" ["dir"]=> string(0) "" ["min_length"]=> int(1) ["max_length"]=> int(1) ["number"]=> int(8) ["state"]=> int(1) ["comment"]=> string(0) "" }

Example of procedural style:

<?php

 $db = mysqli_init();
  mysqli_real_connect($db, "localhost","user1","datasoft123","hr");
  var_dump(mysqli_get_charset($db));

?>

Output:

object(stdClass)#3 (8) { ["charset"]=> string(6) "latin1" ["collation"]=> string(17) "latin1_swedish_ci" ["dir"]=> string(0) "" ["min_length"]=> int(1) ["max_length"]=> int(1) ["number"]=> int(8) ["state"]=> int(1) ["comment"]=> string(0) "" }

Example:

<?php
$con=mysqli_connect("localhost","user1","datasoft123","hr");
// Check connection
if (mysqli_connect_errno())
  {
  echo "Failed to connect to MySQL: " . mysqli_connect_error();
  }

var_dump(mysqli_get_charset($con));

mysqli_close($con);
?>

Output:

object(stdClass)#2 (8) { ["charset"]=> string(6) "latin1" ["collation"]=> string(17) "latin1_swedish_ci" ["dir"]=> string(0) "" 
["min_length"]=> int(1) ["max_length"]=> int(1) ["number"]=> int(8) ["state"]=> int(1) ["comment"]=> string(0) "" }

See also

PHP Function Reference

Previous: field_count
Next: get_client_info