str_pad( string $input, int $pad_length[, string $pad_string[, int $pad_type]] )は、文字列「$input」を、「$pad_length」に指定した長さになるまで、「$pad_type」に指定した方向を、文字「$pad_string」で埋める組み込み関数。
定義
文字列型 str_pad( 文字列型 $input, 整数型 $pad_length[, 文字列型 $pad_string[, 整数型 $pad_type]] );
パラメータ
- 文字列型 $input
入力文字列。
- 整数型 $pad_length
文字列の長さを指定する。
ここに指定した長さになるまで、「$pad_string」で埋める。
- 文字列型 $pad_string
オプション。
「$pad_length」に指定した長さになるまで埋める際に、使用する文字。
初期設定値は、半角空白（半角スペース）。
- 整数型 $pad_type
オプション。
入力文字列の左側を埋めるか、右側を埋めるか、左右均等に埋めるかを指定する。
「STR_PAD_RIGHT」を指定すると、入力文字列の右側を埋める。
「STR_PAD_LEFT」を指定すると、入力文字列の左側を埋める。
「STR_PAD_BOTH」を指定すると、入力文字列の左右を均等に埋める。均等にならない場合は、右側を１つ多く埋める。
初期設定値は、「STR_PAD_RIGHT」。
戻り値
入力文字列「$input」を、「$pad_length」に指定した長さになるまで、「$pad_type」に指定した方向を、文字「$pad_string」で埋めた文字列。
構文
指定した長さになるまで空白で埋める
指定した長さの文字列 = str_pad( 入力文字列, 長さ );
「入力文字列」を、「長さ」に指定した長さになるまで、半角空白（半角スペース）で埋める。
指定した長さになるまで、指定した文字で埋める
指定した長さの文字列 = str_pad( 入力文字列, 長さ, 埋める文字 );
「入力文字列」を、「長さ」に指定した長さになるまで、「埋める文字」で埋める。
指定した長さになるまで、指定した方向を、指定した文字で埋める
指定した長さの文字列 = str_pad( 入力文字列, 長さ, 埋める文字, 埋める方向 );
「入力文字列」を、「長さ」に指定した長さになるまで、「埋める方向」に指定した方向を、「埋める文字」で埋める。
サンプル
指定した長さになるまで空白で埋める
<pre>
<?php
$input = "12345";
echo "[" . str_pad( $input, 10 ) . "]";
?>
</pre>
<?php
$input = "12345";
echo "[" . str_pad( $input, 10 ) . "]";
?>
</pre>
↓↓↓出力結果↓↓↓
[12345 ]
指定した長さになるまで、指定した文字で埋める
<pre>
<?php
$input = "12345";
echo "[" . str_pad( $input, 10, "*" ) . "]\n";
echo "[" . str_pad( $input, 10, "abc" ) . "]";
?>
</pre>
<?php
$input = "12345";
echo "[" . str_pad( $input, 10, "*" ) . "]\n";
echo "[" . str_pad( $input, 10, "abc" ) . "]";
?>
</pre>
↓↓↓出力結果↓↓↓
[12345*****]
[12345abcab]
[12345abcab]
指定した長さになるまで、指定した方向を、指定した文字で埋める
<?php
$input = "12345";
echo str_pad( $input, 10, "*", STR_PAD_RIGHT ) . "<br />";
echo str_pad( $input, 10, "*", STR_PAD_LEFT ) . "<br />";
echo str_pad( $input, 10, "*", STR_PAD_BOTH ) . "<br />";
echo str_pad( $input, 10, "abc", STR_PAD_BOTH ) . "<br />";
?>
$input = "12345";
echo str_pad( $input, 10, "*", STR_PAD_RIGHT ) . "<br />";
echo str_pad( $input, 10, "*", STR_PAD_LEFT ) . "<br />";
echo str_pad( $input, 10, "*", STR_PAD_BOTH ) . "<br />";
echo str_pad( $input, 10, "abc", STR_PAD_BOTH ) . "<br />";
?>
↓↓↓出力結果↓↓↓
12345*****
*****12345
**12345***
ab12345abc
*****12345
**12345***
ab12345abc