str_pad

(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)

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

説明

str_pad(
    string $string,
    int $length,
    string $pad_string = " ",
    int $pad_type = STR_PAD_RIGHT
): string

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

パラメータ

string: 入力文字列。
length: length の値が負、または入力文字列の長さ以下である場合、埋める操作は行われません。 string をそのまま返します。
pad_string: 注意:
必要とされる埋める文字数が pad_string の長さで均等に分割できない場合、pad_string は切り捨てられます。
pad_type: オプションの引数 pad_type には、 STR_PAD_RIGHT, STR_PAD_LEFT, STR_PAD_BOTH を指定可能です。 pad_typeが指定されない場合、 STR_PAD_RIGHT を仮定します。

戻り値

埋めた後の文字列を返します。

例

例1 str_pad() の例


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

関連キーワード: 　pad, string, 固定, type, length, 入力, 関数, int, 分割, 文字数