(PHP 8 >= PHP 8.3.0)
mb_str_pad — Preenche uma string multibyte para um comprimento específico com outra string multibyte
$string
,$length
,$pad_string
= " ",$pad_type
= STR_PAD_RIGHT
,$encoding
= null
Esta função retorna a string
preenchida à esquerda, à direita ou em ambos os lados até o comprimento
de preenchimento especificado, onde o comprimento é medido em pontos de código Unicode. Se o argumento opcional
pad_string
não for fornecido, a
string
será preenchida com espaços, caso contrário, ela
será preenchida com caracteres de pad_string
até o limite.
string
A string de entrada.
length
Se o valor de length
for negativo,
menor ou igual ao comprimento da string de entrada, nenhum preenchimento
ocorre, e a string
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 uniformemente pelo comprimento depad_string
.
pad_type
O argumento opcional pad_type
pode ser
STR_PAD_RIGHT
, STR_PAD_LEFT
,
ou STR_PAD_BOTH
.
Por padrão, STR_PAD_RIGHT
.
encoding
O parâmetro encoding
é a codificação de caracteres. Se for omitido ou null
, o valor da codificação
de caracteres interna será usado.
Retorna a string preenchida.
Exemplo #1 Exemplo de mb_str_pad()
<?php
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_RIGHT)); // string(18) "▶▶❤❓❇❤"
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_LEFT)); // string(18) "❤❓❇❤▶▶"
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_BOTH)); // string(18) "❤❓▶▶❤❓"
var_dump(mb_str_pad("🎉", 3, "祝", STR_PAD_LEFT)); // string(10) "祝祝🎉"
?>