= 4.0.1, PHP 5, PHP 7, PHP 8)str_pad — 使用另一個字符串填充字符串為指定長度說明str_pad( string $input, int $pad_length, string $pad_string = " "="" ",="">

str_pad

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

str_pad — 使用另一個字符串填充字符串為指定長度

說明

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

該函數(shù)返回 input 被從左端、右端或者同時兩端被填充到制定長度后的結果。如果可選的 pad_string 參數(shù)沒有被指定，input 將被空格字符填充，否則它將被 pad_string 填充到指定長度。

參數(shù)

input

輸入字符串。

pad_length

如果 pad_length 的值是負數(shù)，小于或者等于輸入字符串的長度，不會發(fā)生任何填充，并會返回 input 。

pad_string

注意:

如果填充字符的長度不能被 pad_string 整除，那么 pad_string 可能會被縮短。

pad_type

可選的 pad_type 參數(shù)的可能值為 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"
?>