【PHP8.x】str_pad関数の使い方

str_pad関数は、指定された文字列を特定の長さに揃えるためにパディングを実行する関数です。この関数は、元の文字列の長さを増やし、指定した文字で埋めることで、出力のフォーマットを統一したり、視認性を向上させたりする際に役立ちます。

この関数を使用する際は、まずパディングを適用したい「文字列」を指定します。次に、最終的に文字列が持つべき「目標の長さ」を整数で指定します。この目標の長さが元の文字列の長さよりも短い場合、文字列は切り詰められずに元のまま返されます。

さらに、オプションとして二つの引数を指定できます。一つはパディングに使用する「埋め文字」です。これを省略した場合、デフォルトで半角スペースが埋め文字として使われます。もう一つは「パディングの方向」です。これは整数値で指定し、STR_PAD_LEFTを指定すると文字列の左側にパディングが追加され、STR_PAD_RIGHTを指定すると文字列の右側にパディングが追加されます。STR_PAD_BOTHを指定すると、パディングは左右にできるだけ均等に分配されますが、もし均等に分配できない場合は右側により多くのパディングが追加されます。この引数を省略した場合、デフォルトでSTR_PAD_RIGHTが適用されます。

str_pad関数は、パディングされた新しい文字列を生成して返します。元の文字列自体は変更されません。例えば、表形式のデータを整形したり、固定長のファイルを作成したり、あるいはユーザーインターフェース上で文字列をきれいに配置したりするなど、多岐にわたる場面でその機能が活用されます。

<?php
$originalString = "PHP";
$paddedString = str_pad($originalString, 10, "*", STR_PAD_BOTH);
echo $paddedString; // 出力例: ***PHP****
?>

string $string, int $length, string $pad_string = ' ', int $pad_type = STR_PAD_RIGHT

• string $string: パディング処理を行う元の文字列
• int $length: パディング後の文字列の最終的な長さを指定する整数
• string $pad_string = ' ': 元の文字列をパディングするために使用する文字列。省略された場合は半角スペースが使用されます。
• int $pad_type = STR_PAD_RIGHT: パディングの種類を指定します。STR_PAD_RIGHT（右側）、STR_PAD_LEFT（左側）、STR_PAD_BOTH（両側）のいずれかを指定します。省略された場合は右側パディングが使用されます。

string

指定された文字列を指定された長さになるように、指定された文字列で埋め合わせます。