PHP Manual
String-Funktionen
Erweitert einen String unter Verwendung eines anderen Strings auf eine bestimmte Länge

str_pad

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

str_pad — Erweitert einen String unter Verwendung eines anderen Strings auf eine bestimmte Länge

Beschreibung

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

Diese Funktion gibt den String string, erweitert auf der linken, rechten oder auf beiden Seiten auf die angegebene Länge, zurück. Wenn das optionale Argument pad_string nicht angegeben ist, wird string durch Leerzeichen erweitert, anderenfalls bis zum Ende durch die in pad_string angegebenen Zeichen.

Parameter-Liste

string: Die Eingabezeichenkette.
length: Wenn der Wert von length negativ, kürzer als oder gleich der Länge der Eingabezeichenkette ist, wird keine Erweiterung durchgeführt, und string wird unverändert zurückgegeben.
pad_string: Hinweis:
pad_string wird abgeschnitten, falls die benötigte Anzahl der zu ergänzenden Zeichen nicht gleichmäßig durch die Länge von pad_string geteilt werden kann.
pad_type: Das optionale Argument pad_type kann STR_PAD_RIGHT, STR_PAD_LEFT oder STR_PAD_BOTH sein. Wird pad_type nicht angegeben, so wird standardmäßig von STR_PAD_RIGHT ausgegangen.

Rückgabewerte

Gibt die erweiterte Zeichenkette zurück.

Beispiele

Beispiel #1 str_pad()-Beispiel


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