文字列を追加し、指定した文字列の長さに - str_pad関数

プログラミング言語PHPで、文字列を追加し、指定した文字列の長さにする関数 str_pad()を紹介します。

str_pad関数

string str_pad ( string $input , int $pad_length [, string $pad_string = " " [, int $pad_type = STR_PAD_RIGHT ]] )
文字列を追加し、指定した文字列の長さにします。

引数
$input
長さを整える文字列を指定します。
$pad_length
文字列の長さを指定します。
$pad_string
追加する文字列を指定します。指定しない場合（デフォルト）は、半角スペース。
$pad_type
文字列を追加する位置を指定します。
指定しない場合（デフォルト）は、文字列の末尾に追加します。
・STR_PAD_RIGHT 文字列の末尾（右側）
・STR_PAD_LEFT 文字列の先頭（左側）
・STR_PAD_BOTH 文字列の末尾と先頭（両方）

返り値
長さを整えた文字列を返します。

サンプルコード

文字列を追加し、指定した文字列の長さにするサンプルコードです。

str_pad( 文字列, 長さ, [, 追加する文字列 [, 文字列を追加する場所] )

<?php
$string = "abc";
var_dump( $string );
var_dump( str_pad( $string, 10 ) );
var_dump( str_pad( $string, 10, '!' ) );
var_dump( str_pad( $string, 10, '#', STR_PAD_LEFT ) );
var_dump( str_pad( $string, 10, '=', STR_PAD_BOTH ) );
?>

実行結果です。
指定した文字列の長さの文字列が返されています。
第3引数を指定しない場合は、半角スペースが追加されます。
第3引数を指定した場合は、指定した文字列が追加されます。
第4引数を指定した場合は、文字列を追加する場所が変わります。

string(3) "abc"
string(10) "abc       "
string(10) "abc!!!!!!!"
string(10) "#######abc"
string(10) "===abc===="

その他のPHP関数はこちらをご覧ください。

• PHP関数リファレンス

PHPの基本構文はこちらをご覧ください。

• PHP の基本構文

文字列 の人気記事

1. 配列を文字列に変換する - implode()
2. 文字列を大文字 / 小文字に変換 - strtoupper()、strtolower() - mb_strtoupper()、mb_strtolower()
3. 指定した文字列の出現回数をカウント - substr_count()
4. 文字列の長さを取得 - strlen()、mb_strlen()
5. 文字列のエンコーディングを変換 - mb_convert_encoding()
6. 区切り文字列を配列に変換 - explode()
7. 指定した範囲の文字列を置換 - substr_replace関数
8. PHP関数リファレンス