PHP Manual: mb_convert

Description

function 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**
Option	Meaning
`r`	Convert "zen-kaku" alphabets to "han-kaku"
`R`	Convert "han-kaku" alphabets to "zen-kaku"
`n`	Convert "zen-kaku" numbers to "han-kaku"
`N`	Convert "han-kaku" numbers to "zen-kaku"
`a`	Convert "zen-kaku" alphabets and numbers to "han-kaku"
`A`	Convert "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)
`s`	Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020)
`S`	Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000)
`k`	Convert "zen-kaku kata-kana" to "han-kaku kata-kana"
`K`	Convert "han-kaku kata-kana" to "zen-kaku kata-kana"
`h`	Convert "zen-kaku hira-gana" to "han-kaku kata-kana"
`H`	Convert "han-kaku kata-kana" to "zen-kaku hira-gana"
`c`	Convert "zen-kaku kata-kana" to "zen-kaku hira-gana"
`C`	Convert "zen-kaku hira-gana" to "zen-kaku kata-kana"
`V`	Collapse 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".

As of PHP 8.0.0, a ValueError is thrown if encoding is an invalid encoding. Prior to PHP 8.0.0, an E_WARNING was emitted instead.

Changelog

Version	Description
8.2.0	A ValueError is now thrown if the combination of different `mode`s is invalid.
8.0.0	`encoding` is nullable now.
8.0.0	Now throws a ValueError if `encoding` is an invalid encoding. Previously, an `E_WARNING` was emitted and `false` was returned.

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