mb_substr()関数の定義と使い方

mb_substr()関数は、
文字列の特定の位置から指定した長さ分の文字列を抽出するsubstr()関数における、日本語のエンコーディング問題（文字化け）を解決する関数です。

mb_substr()関数は、substr()関数とほぼ同じ機能を持ちながらも、日本語のようなマルチバイト文字列に対して安全に動作するという大きな違いがあります。

substr()関数におけるエンコーディングの問題点

PHP substr()関数における日本語のエンコーディング問題 
echo substr('こんにちは世界', 0, 5);
出力結果 マルチバイト文字の途中で切り取ると、文字化けが発生する可能性があります。

mb_substr()関数によるエンコーディング問題の解決

PHP 
echo mb_substr('こんにちは世界', 0, 5);
出力結果

PHPのsubstr()関数を使用する際、日本語の文字列に対してエンコーディングの問題が発生することがあります。これは、UTF-8のようなマルチバイト文字エンコーディングを使用している場合に主に発生する問題です。

英語や数字などは1バイトですが、日本語や韓国語、中国語などは2バイトです。2バイト以上のバイト数で表現されるものを「multi-byte（マルチバイト）」と言います。

UTF-8のようなマルチバイト文字エンコーディングでは、1文字が複数バイトで表現されるため、通常のバイト数をそのまま使って文字列を切り取ると、予期しない結果を招くことがあります。substr()関数はバイト単位で文字列を切り取るため、マルチバイト文字の途中で切ると文字化けが発生する可能性があります。

このような問題を解決するためには、mb_substr()関数を使用してマルチバイト文字列を正しく切り取ることができます。mb_substr()関数はマルチバイト文字列をサポートしており、正確な文字単位で文字列を切り取ることが可能です。

ご注意ください！
mb_substr()関数は、substr()関数の代わりに安全にマルチバイト文字列を扱うための関数です。

mb_substr()関数の形式は次のとおりです。

構文

PHP 
mb_substr(
    string $string,
    int $start,
    ?int $length = null,
    ?string $encoding = null
): string

引数

mb_substr()関数の引数
$string 必須。抽出したい元の文字列です。
$start 必須。抽出を開始する位置です。
0から始まり、文字列の最初の文字は0番目のインデックスとなります。負の値を使用する場合は、文字列の末尾から逆にカウントされます。例えば、-1は文字列の最後の文字を表し、-2は末尾から2番目の文字を表します。
$length オプション。抽出する文字列の最大長さです。
デフォルト値はnullで、この場合は開始位置から文字列の末尾までのすべての文字を抽出します。
$encoding オプション。 文字列のエンコーディングを指定します。
デフォルト値はnullで、UTF-8などの標準的なエンコーディングを使用する場合は特に指定する必要はありません。省略するかnullを指定すると、内部の文字エンコーディングが使用されます。

戻り値

mb_substr()関数は、部分文字列の抽出に成功した場合、その文字列を返します。

変更履歴

mb_substr() 関数のバージョン別変更履歴
バージョン説明
8.0.0 $encodingパラメータはnull値を許容するように変更されました。これにより、基本のエンコーディングを自動で使用できます。

使い方

mb_substr() 関数の使い方を見ていきましょう。

基本的な使い方

PHP 
$originalString = 'こんにちは、はじめまして！'; 
$start = 3; // 開始位置
$length = 5; // 抽出する長さ

$extractedString = mb_substr($originalString, $start, $length);

echo '抽出された文字列: ' . $extractedString; // 出力例: '抽出された文字列: ちは、はじ'

上記のコードでは、mb_substr()関数を使用してマルチバイト文字列を正しく抽出しています。これにより、日本語の文字列の文字化けを防ぐことができます。

$startパラメータに負の値を使用する例：文字列の末尾から検索する方法

mb_substr()関数の$startパラメータに負の値を指定した場合、文字列の末尾から逆方向にカウントされます。例えば、-1は文字列の最後の文字を示し、-2は末尾から2番目の文字を示します。

以下は、$startパラメータに負の値を使用する例です。

PHP 
$originalString = 'こんにちは、はじめまして！';
$startNegative = -10; // 末尾から10文字目から開始
$length = 5; // 抽出する長さ

$extractedString = mb_substr($originalString, $startNegative, $length);

echo '抽出された文字列: ' . $extractedString; // 出力例: '抽出された文字列: ちは、はじ'

このコードでは、$startNegative変数に-10を割り当てています。これは、文字列「こんにちは、はじめまして！」の末尾から10文字目から開始し、長さ5の文字列「ちは、はじ」を抽出することを意味します。

参考資料

関連項目