(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)
str_pad — Preenche uma string até um determinado comprimento com outra string
$string
,$length
,$pad_string
= " ",$pad_type
= STR_PAD_RIGHT
Esta função retorna a string string
preenchida à esquerda, à direita ou em ambos os lados até o comprimento
de preenchimento especificado. Se o argumento opcional
pad_string
não for fornecido, a
string
será preenchida com espaços,
caso contrário será preenchida com caracteres de pad_string
até o limite.
string
A string de entrada.
length
O comprimento desejado da sequência preenchida final.
Se o valor de length
for negativo,
menor ou igual ao comprimento da string de entrada, nenhum preenchimento
ocorrerá a string
original será retornada.
pad_string
Nota:
O
pad_string
pode ser truncado se o número necessário de caracteres de preenchimento não puder ser dividido igualmente pelo comprimento dopad_string
.
pad_type
O argumento opcional pad_type
pode ser
STR_PAD_RIGHT
, STR_PAD_LEFT
ou STR_PAD_BOTH
. Se
pad_type
não for especificado, será assumido como
STR_PAD_RIGHT
.
Retorna a string preenchida.
Exemplo #1 Exemplo de str_pad()
<?php
$input = "Alien";
echo str_pad($input, 10); // produz "Alien "
echo str_pad($input, 10, "-=", STR_PAD_LEFT); // produz "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH); // produz "__Alien___"
echo str_pad($input, 6, "___"); // produz "Alien_"
echo str_pad($input, 3, "*"); // produz "Alien"
?>