str_pad関数とは
PHPのstr_pad関数は、文字列の長さを一定の長さに調整するために使用します。指定した長さになるように、文字列の前または後ろに文字を追加することができます。
str_pad関数の構文：
str_pad($input, $length, $pad_string = ” “, $pad_type = STR_PAD_RIGHT);
● $input: パディングしたい元の文字列
● $length: パディング後の文字列の長さ
● $pad_string: パディングに使用する文字（デフォルトは空白）
● $pad_type: パディングの種類で
● STR_PAD_RIGHT: 文字列を右にパディング
● STR_PAD_LEFT: 文字列を左にパディング
● STR_PAD_BOTH: 文字列を両側にパディング
実際の例
$original = “PHP”;
例1: 文字列を右にパディング
$padded = str_pad($original, 10, “-“);
⇒この例では、「PHP」という文字列が10文字になるように、後ろにハイフン（-）が追加されています。
例2: 文字列を左にパディング
$padded = str_pad($original, 10, “-“, STR_PAD_LEFT);
⇒こちらでは、「PHP」が左にパディングされ、前にハイフンが追加されています。
例3: 文字列を両側にパディング
$padded = str_pad($original, 10, “-“, STR_PAD_BOTH);
⇒この場合、「PHP」が中央に配置され、両側にハイフンが追加されています。
なぜstr_padを使うのか
それは、プログラミングでは、文字列の長さを固定することがよくあるからです。特に、ユーザーからの入力を処理したり、レポートを作成する際に便利です。たとえば、データベースの出力や帳票に一定の長さを持つ文字列を作成する場合に役立ちます。
str_pad使用時の注意点
１．もし、入力文字列がすでに指定した長さ以上であれば、何も変更されません。
２．適切なパディング文字とパディングの種類を選択して、期待する結果を得るようにしましょう。