定義と使い方
- PHPバージョン
- 7.4+
mb_str_split()関数は、日本語などのマルチバイト文字列を、指定した一定の長さの部分文字列に分割して配列に変換する関数です。
戻り値は、分割された部分文字列を格納した配列です。
str_split()関数とほぼ同じ機能を持ちますが、日本語などのmulti-byte文字列でも安全に動作する機能を提供する点が大きな違いです。
補足説明
UTF-8エンコーディングでは、英語や数字などのASCII文字は1バイトで表現されますが、日本語や韓国語、中国語などは複数のバイトを使用します。このように、1つの文字を表現するために2バイト以上を使用する文字をmulti-byte(マルチバイト)文字列といいます。
PHP 7.4で導入された関数であり、PHP 7.4より前のバージョンには対応していません。
基本例
$str = 'よろしくお願いします!';
/* 文字列を1文字ずつ分割する例
str_split()とmb_str_split()の違い */
// 日本語に対応していません(長さは1バイト単位です。)
$arr1 = str_split($str, 1);
print_r($arr1);
/* 出力:
Array
(
[0] => �
[1] => �
[2] => �
[3] => �
[4] => �
[5] => �
[6] => �
[7] => �
[8] => �
[9] => �
[10] => �
[11] => �
[12] => �
[13] => �
[14] => �
[15] => �
[16] => �
[17] => �
[18] => �
[19] => �
[20] => �
[21] => �
[22] => �
[23] => �
[24] => �
[25] => �
[26] => �
[27] => �
[28] => �
[29] => �
[30] => �
[31] => �
[32] => �
)
*/
// 日本語などのマルチバイト文字列に対応しています(長さは文字単位です。)
$arr2 = mb_str_split($str, 1, 'UTF-8');
print_r($arr2);
/* 出力:
Array
(
[0] => よ
[1] => ろ
[2] => し
[3] => く
[4] => お
[5] => 願
[6] => い
[7] => し
[8] => ま
[9] => す
[10] => !
)
*/
構文
mb_str_split(string $string, int $length = 1, ?string $encoding = null): array
パラメータ
$string |
必須。分割する対象の文字列です。 |
|---|---|
$length |
オプション。各部分文字列の長さを指定するパラメータです。このパラメータを使用しない場合は、デフォルト値として1が指定され、各文字を1つの要素とする配列が生成されます。 |
$encoding |
オプション。文字列のエンコーディングを指定します。 デフォルト値は nullであり、省略するかnullを渡すと、内部文字エンコーディングの値が使用されます。
|
戻り値
パラメータとして渡された$lengthの長さの部分文字列に分割し、配列に変換して返します。
このとき、長さは文字単位を基準とします。
変更履歴
| バージョン | 説明 |
|---|---|
| 8.0.0 | PHP 8.0.0から$encodingパラメータがnullableに変更されました。これにより、$encodingパラメータを省略するか、nullに設定できるようになりました。以前は、有効なエンコーディングを必ず指定する必要がありました。 |
| 8.0.0 | PHP 8.0.0から、関数が失敗した場合でもfalseを返さなくなりました。以前は関数が失敗するとfalseを返していましたが、現在は失敗した場合でも戻り値がfalseになることはありません。代わりに、関数は常に配列を返すようになりました。失敗した場合は空の配列が返されます。 |
活用例
mb_str_split()関数は、マルチバイト文字列かどうかに関係なく、文字列を簡単に部分文字列に分割できるため、さまざまな場面で活用できます。いくつかの例を見てみましょう。
文字列を逆順に出力する
文字列を逆順に出力するには、mb_str_split()関数を使用して文字列を配列に分割した後、array_reverse()関数を使用して配列を逆順に変更できます。
逆順に変更した配列は、再びimplode()関数を使用して、配列を文字列に変換します。
$str = 'ようこそ';
$array = mb_str_split($str, 1, 'UTF-8');
$reversed_array = array_reverse($array);
$reversed_string = implode('', $reversed_array);
echo $reversed_string; // 出力: 'そこうよ'
コードの補足説明array_reverse()関数は、指定した配列の要素の順序を逆順(reverse)にして返します。
コードの補足説明implode()関数は、配列の要素を1つの文字列に結合して変換する関数です。
名前/IDなどの一部の情報を隠す
名前やIDなどの機密情報の特定の部分を隠すには、mb_str_split()関数を使用して文字列を分割した後、一部を変更できます。
例えば、ユーザー名の中央の文字を*でマスキングする場合、文字列を配列に変換して、日本語が文字化けしないよう安全に処理します。
function mask_name($name) {
// 日本語/多言語の文字列を1文字ずつ配列に分割
$chars = mb_str_split($name, 1, 'UTF-8');
$length = count($chars);
if ($length <= 1) {
return $name;
}
if ($length === 2) {
// 2文字の名前(例:山田 -> 山*)
$chars[1] = '*';
} else {
// 3文字以上(例:山田太郎 -> 山**郎、佐々木太郎 -> 佐***郎)
for ($i = 1; $i < $length - 1; $i++) {
$chars[$i] = '*';
}
}
return implode('', $chars);
}
echo mask_name("山"); // 山
echo "<br>";
echo mask_name("山田"); // 山*
echo "<br>";
echo mask_name("山田太郎"); // 山**郎
echo "<br>";
echo mask_name("佐々木太郎"); // 佐***郎
echo "<br>";
echo mask_name("すてきな名前"); // す****前
コードの補足説明for文は、特定の回数や範囲だけ繰り返す反復文です。
上記の例では、mb_str_split()関数を使用して文字列を簡単に扱う方法を示しました。
この関数は、マルチバイト文字列かどうかに関係なく、文字列を部分文字列に分割するのに便利で、これにより文字列をさまざまな方法で加工できます。