mb_str_pad

(PHP 8 >= PHP 8.3.0)

mb_str_pad — Remplit une chaîne multioctets à une certaine longueur avec une autre chaîne multioctets

Description

mb_str_pad(
    string $string,
    int $length,
    string $pad_string = " ",
    int $pad_type = STR_PAD_RIGHT,
    ?string $encoding = null
): string

Cette fonction renvoie le string rempli sur la gauche, la droite, ou les deux côtés à la longueur de remplissage spécifiée, où la longueur est mesurée en points de code Unicode. Si l'argument optionnel pad_string n'est pas fourni, le string est rempli avec des espaces, sinon il est rempli avec des caractères de pad_string jusqu'à la limite.

Liste de paramètres

string: La chaîne d'entrée.
length: Si la valeur de length est négative, inférieure ou égale à la longueur de la chaîne d'entrée, aucun remplissage n'a lieu, et string sera renvoyé.
pad_string: Note:
Le pad_string peut être tronqué si le nombre requis de caractères de remplissage ne peut pas être divisé de manière égale par la longueur du pad_string.
pad_type: L'argument optionnel pad_type peut être STR_PAD_RIGHT, STR_PAD_LEFT, ou STR_PAD_BOTH. Par défaut STR_PAD_RIGHT.
encoding: Le paramètre encoding est l'encodage des caractères. S'il est omis ou null, l'encodage de caractères interne sera utilisé.

Valeurs de retour

Renvoie la chaîne remplie.

Exemples

Exemple #1 Exemple avec 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) "祝祝🎉"
?>