str_pad

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

str_padComplète une chaîne jusqu'à une taille donnée

Description

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

Retourne la chaîne string, complétée à droite, à gauche ou dans les deux sens, avec la chaîne pad_string jusqu'à ce qu'elle atteigne la taille de length.

Liste de paramètres

string

La chaîne d'entrée.

length

Si la valeur de length est négative, plus petite que, ou égale à la taille courante de la chaîne string, string est retournée inchangée et string sera retourné.

pad_string

Note:

Le paramètre pad_string peut être tronqué si le nombre de caractères de complétion n'est pas multiple de la taille de pad_string.

pad_type

L'argument optionnel pad_type peut être l'une des constantes suivantes : STR_PAD_RIGHT, STR_PAD_LEFT, ou STR_PAD_BOTH. Si pad_type n'est pas spécifié, il prend la valeur par défaut de STR_PAD_RIGHT.

Valeurs de retour

Retourne la chaîne complétée.

Exemples

Exemple #1 Exemple avec str_pad()

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