str_pad

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

str_pad — Rellena un string hasta una longitud determinada con otro string

Descripción

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

Esta función devuelve el string input rellenado por la izquierda, la derecha, o en ambos lados hasta la longitud especificada. Si el argumento opcional pad_string no se suministra, el input se rellena con espacios, de lo contrario, se rellena con los caracteres de pad_string hasta el límite.

Parámetros

input: El string de entrada.
pad_length: La longitud del relleno. Si el valor de pad_length es negativo, inferior o igual a la longitud del string de entrada, no se realizará ningún relleno, devolviendo así input.
pad_string: Nota:
El pad_string se puede truncar si el número necesario de caracteres de relleno no pueden ser divididos uniformemente por la longitud de pad_string.
pad_type: El argumento opcional pad_type puede ser STR_PAD_RIGHT, STR_PAD_LEFT, o STR_PAD_BOTH. Si no se especifica pad_type se asume como STR_PAD_RIGHT.

Valores devueltos

Devuelve el string rellenado.

Ejemplos

Ejemplo #1 Ejemplo de str_pad()

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