PHP: String vorne oder hinten mit beliebigen Zeichen auf bestimmte Länge auffüllen

In diesem kleinen Tipp möchte ich euch eine nützliche PHP Funktion vorstellen.

Oftmals haben wir Strings einer bestimmten Länge und wollen sie hinten oder vorne mit irgendeinem Zeichen auffüllen, so dass die Strings auf eine einheitliche Länge kommen. Denkbar wären zum Beispiel Nummern, bündig zu schreibende Namen oder das auffüllen kürzerer Zahlen mit Nullen, also zum Beispiel:

0000123
0012345
0000012

Wollen wir dieses Resultat durch eine eigene Funktion herstellen, benötigen wir dazu einige Zeilen Code.

Zum Glück bringt PHP aber auch schon von zuhause aus eine entsprechende Funktion mit. Sie heißt str_pad() und man verwendet sie folgendermaßen:

$str = 'abc';
echo str_pad($str, 5, '.');                // '..abc'
echo str_pad($str, 5, '.', STR_PAD_RIGHT); // '..abc'
echo str_pad($str, 5, '.', STR_PAD_LEFT);  // 'abc..'
echo str_pad($str, 5, '.', STR_PAD_BOTH);  // '.abc.'
echo str_pad($str, 8, '. ');               // '. . .abc'
echo str_pad($str, 8);                     // '     abc'

Die Funktion erwartet als ersten Parameter einen String und als zweiten Parameter einen Wert, wie lang der String werden soll.

Der dritte, optionale Parameter gibt das oder die Zeichen an, die zum Auffüllen verwendet werden sollen. Lässt man diesen Parameter weg, wird mit einem Leerzeichen aufgefüllt. Falls die mehrere Zeichen nicht zum Auffüllen passen, wird einfach abgeschnitten, so dass man auf die richtige Länge kommt.

Der vierte und letzte Parameter gibt an, ob der String rechtsbündig (STR_PAD_RIGHT), linksbündig (STR_PAD_LEFT) oder mittig (STR_PAD_BOTH) aufgefüllt werden soll. Lässt man diesen Parameter weg, wird rechtsbündig aufgefüllt.