str_pad

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

str_padCompleta un string hasta un tamaño dado

Descripción

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

Retorna el string string, completado a la derecha, a la izquierda o en ambos lados, con el string pad_string hasta que alcance el tamaño de length.

Parámetros

string

El string de entrada.

length

La longitud deseada del string final completado. Si el valor de length es negativo, menor que, o igual al tamaño actual del string string, string se retorna sin cambios.

pad_string

Nota:

El argumento pad_string puede ser truncado si el número de caracteres de completado no es múltiplo del tamaño de pad_string.

pad_type

El argumento opcional pad_type puede ser una de las constantes siguientes: STR_PAD_RIGHT, STR_PAD_LEFT, o STR_PAD_BOTH. Si pad_type no es especificado, toma el valor por omisión de STR_PAD_RIGHT.

Valores devueltos

Retorna el string completado.

Ejemplos

Ejemplo #1 Ejemplo con str_pad()

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

Ver también

  • mb_str_pad() - Rellena una cadena multibyte hasta una cierta longitud con otra cadena multibyte