【PHP8.x】mb_str_pad()関数の使い方

Copy
1<?php
2
3// システムエンジニアを目指す初心者の方へ:
4// mb_str_pad関数は、マルチバイト文字（日本語や中国語など）を正しく扱って文字列をパディング（指定の長さに揃える）するために使います。
5// 通常のstr_pad関数では、全角文字を1文字ではなく複数バイトとして数えてしまうため、表示がずれる可能性がありますが、
6// mb_str_padは文字数ベースで正確に処理します。
7
8// mb_str_padの動作を理解するために、内部エンコーディングをUTF-8に設定します。
9// これにより、マルチバイト文字列が正しく処理されることを保証します。
10mb_internal_encoding("UTF-8");
11
12// パディングする元の文字列（日本語を含む）
13$originalString = "PHPプログラミング";
14// パディング後の目標文字数 (マルチバイト文字数でカウント)
15$targetLength = 20;
16// パディングに使用する文字
17$padString = "=";
18
19echo "元の文字列: \"{$originalString}\" (文字数: " . mb_strlen($originalString) . ")\n\n";
20
21// 1. 文字列の右側にパディング (デフォルトの挙動)
22// mb_str_pad($string, $length, $pad_string, STR_PAD_RIGHT, $encoding);
23$paddedRight = mb_str_pad($originalString, $targetLength, $padString, STR_PAD_RIGHT);
24echo "右パディング (STR_PAD_RIGHT):\n";
25echo "  \"{$paddedRight}\" (文字数: " . mb_strlen($paddedRight) . ")\n\n";
26
27// 2. 文字列の左側にパディング
28// mb_str_pad($string, $length, $pad_string, STR_PAD_LEFT, $encoding);
29$paddedLeft = mb_str_pad($originalString, $targetLength, $padString, STR_PAD_LEFT);
30echo "左パディング (STR_PAD_LEFT):\n";
31echo "  \"{$paddedLeft}\" (文字数: " . mb_strlen($paddedLeft) . ")\n\n";
32
33// 3. 文字列の左右にパディング
34// mb_str_pad($string, $length, $pad_string, STR_PAD_BOTH, $encoding);
35$paddedBoth = mb_str_pad($originalString, $targetLength, $padString, STR_PAD_BOTH);
36echo "左右パディング (STR_PAD_BOTH):\n";
37echo "  \"{$paddedBoth}\" (文字数: " . mb_strlen($paddedBoth) . ")\n\n";
38
39// 補足: $encoding 引数を明示的に指定することも可能ですが、
40// mb_internal_encodingを設定していれば通常は省略可能です。
41// 例: mb_str_pad($originalString, $targetLength, $padString, STR_PAD_RIGHT, "UTF-8");
42
43?>

PHPのmb_str_pad関数は、マルチバイト文字（日本語や中国語など）を正しく扱って文字列を指定された長さに揃える（パディングする）ために使用されます。通常のstr_pad関数では、全角文字をバイト数で数えてしまうため、意図しない表示のずれが発生する可能性がありますが、mb_str_padは文字数ベースで正確に処理するため、多言語環境での文字列整形に不可欠です。

この関数は、string $stringとしてパディングしたい元の文字列、int $lengthとしてパディング後の目標文字数、string $pad_stringとしてパディングに使用する文字、int $pad_typeとしてパディングの方向、そして?string $encodingとして文字エンコーディングを指定します。$pad_typeには、STR_PAD_RIGHT（右側にパディング）、STR_PAD_LEFT（左側にパディング）、STR_PAD_BOTH（左右に均等にパディング）のいずれかを指定します。$encoding引数は、mb_internal_encodingで設定されている場合は省略可能です。戻り値は、パディングされた新しい文字列です。

サンプルコードでは、まずmb_internal_encoding("UTF-8")で内部エンコーディングを設定し、マルチバイト文字列が適切に処理されるようにしています。次に「PHPプログラミング」という日本語を含む文字列を基に、目標文字数20、パディング文字「=」で動作を確認しています。STR_PAD_RIGHTを指定すると文字列の右側に「=」が追加されて「PHPプログラミング========」のように右詰めになります。STR_PAD_LEFTでは左側に「========PHPプログラミング」のように左詰めとなり、STR_PAD_BOTHでは「====PHPプログラミング=====」のように文字列の左右に均等に「=」が配置され、中央揃えのような結果が得られます。このようにmb_str_padを利用することで、マルチバイト文字を含む文字列を正確に整形し、見やすい形式に調整することができます。

Copy
1<?php
2
3/**
4 * mb_str_pad と mb_strwidth を使用して、マルチバイト文字列を正しくパディングする例。
5 *
6 * mb_strwidth はマルチバイト文字の表示幅を計算し、
7 * mb_str_pad はその表示幅を考慮して文字列を整形します。
8 */
9function demonstrateMbStrPadWithWidthHandling(): void
10{
11    // パディングする日本語文字列 (全角文字は表示幅が2)
12    $japaneseString = "こんにちはPHP"; // 7文字だが、全角なので表示幅は14 (7 * 2)
13
14    // mb_strwidth で文字列の表示幅を確認
15    // 日本語のような全角文字は通常、表示幅が2バイト相当とカウントされます。
16    $width = mb_strwidth($japaneseString, 'UTF-8');
17    echo "元の文字列: '{$japaneseString}'\n";
18    echo "mb_strwidthでの表示幅: {$width}\n\n";
19
20    // mb_str_pad でパディング
21    // 目標の表示幅を20とする
22    $targetWidth = 20;
23    $padChar = '-'; // パディングに使う文字
24
25    echo "--- mb_str_pad の使用例 (目標表示幅: {$targetWidth}) ---\n";
26    // 右寄せパディング
27    $paddedStringRight = mb_str_pad($japaneseString, $targetWidth, $padChar, STR_PAD_RIGHT, 'UTF-8');
28    echo "右パディング: '{$paddedStringRight}' (実表示幅: " . mb_strwidth($paddedStringRight, 'UTF-8') . ")\n";
29
30    // 左寄せパディング
31    $paddedStringLeft = mb_str_pad($japaneseString, $targetWidth, $padChar, STR_PAD_LEFT, 'UTF-8');
32    echo "左パディング: '{$paddedStringLeft}' (実表示幅: " . mb_strwidth($paddedStringLeft, 'UTF-8') . ")\n";
33
34    // 中央寄せパディング
35    $paddedStringBoth = mb_str_pad($japaneseString, $targetWidth, $padChar, STR_PAD_BOTH, 'UTF-8');
36    echo "中央パディング: '{$paddedStringBoth}' (実表示幅: " . mb_strwidth($paddedStringBoth, 'UTF-8') . ")\n\n";
37
38    // 比較のために、通常の str_pad も試す
39    // str_pad は文字数ベースでパディングするため、全角文字を1文字として扱い、表示がずれます。
40    $targetLength = 20; // 文字数ベース
41    $normalPaddedString = str_pad($japaneseString, $targetLength, $padChar, STR_PAD_RIGHT);
42    echo "--- str_pad との比較 (目標文字数: {$targetLength}) ---\n";
43    echo "str_pad (右パディング): '{$normalPaddedString}' (実表示幅: " . mb_strwidth($normalPaddedString, 'UTF-8') . ")\n";
44    echo "str_pad は全角文字を1文字として扱うため、表示幅が期待通りにならない点に注目してください。\n";
45}
46
47// 関数を実行
48demonstrateMbStrPadWithWidthHandling();
49

mb_str_pad関数は、PHPで日本語の全角文字のようなマルチバイト文字列を、指定した「表示幅」に合わせて整形（パディング）する際に使用される関数です。通常のstr_pad関数が文字数を基準にパディングを行うのに対し、mb_str_padは全角文字の表示幅（通常半角文字の2倍）を考慮するため、mb_strwidth関数で計算される正確な表示幅に基づいて文字列を綺麗に揃えることができます。これは、文字が混在するリストやレポートの出力で、見た目の位置ずれを防ぐ上で非常に重要です。

この関数は、第1引数にパディングしたい文字列、第2引数に最終的に文字列が持つべき目標の「表示幅」、第3引数に埋める文字（省略時は半角スペース）、第4引数にパディングの方向（右寄せ、左寄せ、中央寄せ）、そして第5引数に処理する文字のエンコーディングを受け取ります。戻り値としては、指定された表示幅にパディングされた新しい文字列が返されます。

サンプルコードでは、まずmb_strwidthを用いて日本語文字列「こんにちはPHP」の表示幅が14であることを確認しています。次に、mb_str_padを使用してこの文字列を目標表示幅20に右、左、中央へとパディングする様子を示しています。例えば右パディングの場合、元の表示幅14に対し、不足する6文字分のハイフン「------」が右側に追加され、全体の表示幅が20に整えられます。最後に、通常のstr_pad関数と比較することで、mb_str_padがマルチバイト文字の表示幅を正確に扱い、結果として表示のずれを防ぐことの重要性を明確に示しています。str_padは文字数を基準とするため、全角文字の幅を考慮せず、期待通りの見た目にならない点が確認できます。