(PHP 8 >= PHP 8.3.0)
mb_str_pad — Rellena una cadena multibyte hasta una cierta longitud con otra cadena multibyte
$string
,$length
,$pad_string
= " ",$pad_type
= STR_PAD_RIGHT
,$encoding
= null
Esta función devuelve el string
rellenado por la izquierda, la derecha o ambos lados hasta la longitud de
relleno especificada, donde la longitud se mide en puntos de código Unicode. Si el argumento opcional
pad_string
no se proporciona, el
string
se rellena con espacios, de lo contrario se
rellena con caracteres de pad_string
hasta el límite.
string
La cadena de entrada.
length
Si el valor de length
es negativo,
inferior o igual a la longitud de la cadena de entrada, no se realiza ningún relleno
y string
será devuelto.
pad_string
Nota:
El
pad_string
puede ser truncado si el número requerido de caracteres de relleno no puede ser dividido equitativamente por la longitud delpad_string
.
pad_type
El argumento opcional pad_type
puede ser
STR_PAD_RIGHT
, STR_PAD_LEFT
,
o STR_PAD_BOTH
.
Por omisión STR_PAD_RIGHT
.
encoding
El parámetro encoding
es la codificación de caracteres. Si es omitido o null
, será usado el valor de la
codificación de caracteres interna.
Devuelve la cadena rellenada.
Ejemplo #1 Ejemplo 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) "祝祝🎉"
?>