str_pad

(PHP 4 >= 4.0.1, PHP 5)

str_pad -- 文字列を固定長の他の文字列で埋める

説明

string str_pad ( string input, int pad_length [, string pad_string [, int pad_type]] )

この関数は文字列 input の左、右または両側を 指定した長さで埋めます。オプションの引数 pad_string が指定されていない場合は、 inputは空白で埋められ、それ以外の場合は、 pad_string からの文字で制限まで埋められます。

オプションの引数pad_typeには、 STR_PAD_RIGHT, STR_PAD_LEFT, STR_PAD_BOTH を指定可能です。 pad_typeが指定されない場合、 STR_PAD_RIGHT を仮定します。

pad_lengthの値が負または入力文字列の長さよ りも短い場合、埋める操作は行われません。

例 1. str_pad()の例

<?php
$input
= "Alien";
echo
str_pad($input, 10);                      // produces "Alien     "
echo str_pad($input, 10, "-=", STR_PAD_LEFT);  // produces "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH);   // produces "__Alien___"
echo str_pad($input, 6 , "___");               // produces "Alien_"
?>

注意: 必要とされる埋める文字数が pad_string の長さで均等に分割できない場合、pad_string は 切り捨てられます。