mb_encoding_aliases()

mb_encoding_aliases() — Get aliases of a known encoding type.

Built-in function of PHP 8.5. The manual lists it as available in PHP 5 >= 5.3.0, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

Signature

mb_encoding_aliases(string $encoding): array

Parameters

ParameterTypeWhat it takes
$encodingstringThe encoding type being checked, for aliases.

Return value

Returns a numerically indexed array of encoding aliases.

Example

A runnable snippet:

$encoding = 'ASCII'; $known_encodings = mb_list_encodings(); if (in_array($encoding, $known_encodings)) { $aliases = mb_encoding_aliases($encoding); print_r($aliases); } else { echo "Unknown ($encoding) encoding.\n"; }

Output:

Array ( [0] => ANSI_X3.4-1968 [1] => iso-ir-6 [2] => ANSI_X3.4-1986 [3] => ISO_646.irv:1991 [4] => US-ASCII [5] => ISO646-US [6] => us [7] => IBM367 [8] => cp367 [9] => csASCII )

Changelog

VersionChange
8.0.0Now throws a ValueError if encoding is an invalid encoding. Previously, an E_WARNING was emitted and false was returned.

See also

mb_list_encodings()

All PHP 8.5 built-in functions

Reference card built from the PHP manual page mb_encoding_aliases() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.