mb_convert_kana

(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)

mb_convert_kana — Convert "kana" one from another ("zen-kaku", "han-kaku" and more)

Description

mb_convert_kana(string $string, string $mode = "KV", ?string $encoding = null): string

Performs a "han-kaku" - "zen-kaku" conversion for string string. This function is only useful for Japanese.

Parameters

string

The string being converted.

mode

The conversion option.

Specify with a combination of following options.

Applicable Conversion Options
OptionMeaning
rConvert "zen-kaku" alphabets to "han-kaku"
RConvert "han-kaku" alphabets to "zen-kaku"
nConvert "zen-kaku" numbers to "han-kaku"
NConvert "han-kaku" numbers to "zen-kaku"
aConvert "zen-kaku" alphabets and numbers to "han-kaku"
AConvert "han-kaku" alphabets and numbers to "zen-kaku" (Characters included in "a", "A" options are U+0021 - U+007E excluding U+0022, U+0027, U+005C, U+007E)
sConvert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020)
SConvert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000)
kConvert "zen-kaku kata-kana" to "han-kaku kata-kana"
KConvert "han-kaku kata-kana" to "zen-kaku kata-kana"
hConvert "zen-kaku hira-gana" to "han-kaku kata-kana"
HConvert "han-kaku kata-kana" to "zen-kaku hira-gana"
cConvert "zen-kaku kata-kana" to "zen-kaku hira-gana"
CConvert "zen-kaku hira-gana" to "zen-kaku kata-kana"
VCollapse voiced sound notation and convert them into a character. Use with "K","H"

encoding

The encoding parameter is the character encoding. If it is omitted or null, the internal character encoding value will be used.

Return Values

The converted string.

Errors/Exceptions

Throws a ValueError if the combination of different modes is invalid. For example "sS".

Changelog

VersionDescription
8.2.0A ValueError is now thrown if the combination of different modes is invalid.
8.0.0encoding is nullable now.

Examples

Example #1 mb_convert_kana() example

<?php
/* Convert all "han-kaku" "kata-kana" to "zen-kaku" "hira-gana" */
echo mb_convert_kana('ﾔﾏﾀﾞ ﾊﾅｺ', "HV") . "\n";

/* Convert "han-kaku" "kata-kana" to "zen-kaku" "kata-kana"
and "zen-kaku" alphanumeric to "han-kaku" */
echo mb_convert_kana('ｺｳｻﾞﾊﾞﾝｺﾞｳ ０１２３４５６', "KVa") . "\n";
?>

The above example will output:

やまだ はなこ
コウザバンゴウ 0123456