mb_convert_variables

Convert character code in variable(s).

mb_convert_variables Function synopsis

mb_convert_variables(
    string $to_encoding,
    array|string $from_encoding,
    mixed &$var,
    mixed ...&$vars
  ): string|false

Parameters

$to_encoding

Typestring

The encoding that the string is being converted to.

$from_encoding

Typearray|string

$from_encoding is specified as an array or comma separated string, it tries to detect encoding from $from_coding. When $from_encoding is omitted, detect_order is used.

$var

Passed by referenceTypemixed

$var is the reference to the variable being converted. String, Array and Object are accepted. mb_convert_variables assumes all parameters have the same encoding.

$vars

Variadic, Passed by reference, OptionalTypemixed

Additional $vars.

Note that the parameters $var and $vars are passed by reference, and contain additional/updated context data that may be useful.

Return value

Typestring|false

The character encoding before conversion for success, or false for failure.