Gibt einen formatierten String zurück

# sprintf

(PHP 4, PHP 5, PHP 7, PHP 8)

sprintf — Gibt einen formatierten String zurück

### Beschreibung

function sprintf(string `$format`, mixed `...$values`): string

Gibt eine anhand des Formatierungs-Strings `format` gebildete Zeichenkette zurück.

### Parameter-Liste

`format`

  Der Formatstring setzt sich aus keiner oder mehreren Anweisungen zusammen: Normale Zeichen (abgesehen von `%`), die direkt in das Ergebnis kopiert werden und Konvertierungsanweisungen, die jeweils ihre eigenen Parameter abrufen.

  Eine Konvertierungsanweisung folgt diesem Prototypen: `%[ArgNum$][Flags][Weite][.Präzision]Spezifizierer`.

  ##### ArgNum

  Eine Ganzzahl gefolgt von einem Dollarzeichen `$`, die die Nummer des Arguments angibt, das für die Konversion verwendet werden soll.

  ##### Flags

  Flag | Beschreibung
  --- | ---
  `-` | Linksbündig innerhalb der angegebenen Feldbreite; Rechtsbündig ist der Standard
  `+` | Positive Zahlen mit einem Pluszeichen `+`; Standardmäßig werden nur negative Zahlen mit negativen Vorzeichen ausgegeben
  `` (Leerzeichen) | Füllt das Ergebnis mit Leerzeichen auf. Dies ist der Standard.
  `0` | Füllt nach Links mit Nullen auf. Mit dem `s`-Spezifizierer kann dies auch nach rechts mit Nullen auffüllen.
  `'`(Zeichen) | Füllt das Ergebnis mit dem angegebenen Zeichen auf.

  ##### Breite

  Entweder eine Ganzzahl die angibt, wie viele Zeichen (Minimum) das Konvertierungsergebnis haben soll oder `*`. Wenn `*` verwendet wird, wird die Breite als zusätzlicher ganzzahliger Wert angegeben, der bestimmt, wie viele Zeichen vor dem durch den Spezifizierer formatierten Wert stehen sollen.

  ##### Genauigkeit

  Ein Punkt `.`, optional gefolgt von einer Ganzzahl oder `*`, dessen Bedeutung vom Spezifizierer abhängt:

  - Für die Spezifizierer `e`, `E`, `f` und `F`: Dies stellt die Anzahl der Nachkommastellen an, die nach dem Dezimaltrennzeichen ausgegeben werden soll (Standardmäßig ist dies 6).
  - Für die Spezifizierer `g`, `G`, `h` und `H`: Die maximale Anzahl der auszugebenenden signifikanten Nachkommastellen.
  - Für den `s` Spezifizierer: Verhält sich wie ein Abschneidepunkt, der eine maximale Anzahl an Zeichen in der Zeichenkette angibt.

  > Hinweis: Wenn der Punkt ohne einen expliziten Wert für die Genauigkeit angegeben wird, wird 0 angenommen. Wenn `*` verwendet wird, wird die Genauigkeit als zusätzliche Ganzzahl vor dem durch den Bezeichner formatierten Wert angegeben.

  Spezifizierer
  Spezifizierer | Beschreibung
  --- | ---
  `%` | Ein Prozentzeichen. Kein Parameter nötig.
  `b` | Der Parameter wird als Ganzzahl behandelt und als Binärzahl ausgegeben.
  `c` | Der Parameter wird als Ganzzahl behandelt und als Zeichen aus dem ASCII-Zeichensatz ausgegeben.
  `d` | Der Parameter wird als Ganzzahl behandelt und als (vorzeichenbehaftete) Dezimalzahl ausgegeben.
  `e` | Der Parameter wird als Zahl in wissenschaftlicher Schreibweise (z. B. 1.2e+2) behandelt.
  `E` | Wie der Spezifizierer `e`, aber schreibt einen Großbuchstaben (z. B. 1.2E+2).
  `f` | Der Parameter wird als Gleitkommazahl betrachtet und als Gleitkommazahl ausgegeben (abhängig von der Locale).
  `F` | Der Parameter wird als Gleitkommazahl betrachtet und als Gleitkommazahl (unabhängig von der Locale) ausgegeben.
  `g` | Generelles Format. Sei P gleich der Genauigkeit, wenn nicht Null, 6, wenn die Genauigkeit nicht angegeben ist, oder 1 wenn die Genauigkeit Null ist. Dann, wenn eine Konvertierung mittels E einen Exponenten von X hätte: Wenn P > X ≥ −4, erfolgt die Konvertierung mit Spezifizierer f und Genauigkeit P - (X + 1), andernfalls mit Spezifizierer e und Genauigkeit P - 1.
  `G` | Wie der Spezifizierer `g`, aber es wird `E` und `f` verwendet.
  `h` | Wie der Spezifizierer `g`, aber es werden `F` verwendet. Verfügbar ab PHP 8.0.0.
  `H` | Wie der Spezifizierer `g`, aber es werden `E` und `F` verwendet. Verfügbar ab PHP 8.0.0.
  `o` | Der Parameter wird als Ganzzahl betrachtet und als Oktalzahl ausgegeben.
  `s` | Der Parameter wird als Zeichenkette betrachtet und ausgegeben.
  `u` | Der Parameter wird als Ganzzahl betrachtet und als vorzeichenlose Dezimalzahl ausgegeben.
  `x` | Der Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit Kleinbuchstaben) ausgegeben.
  `X` | Der Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit Großbuchstaben) ausgegeben.

  Warnung

  Der Spezifizierer `c` ignoriert Auffüllung und Weite.

  Warnung

  Der Versuch, die Kombination aus Zeichenketten mit Weite-Spezifizierern und Zeichensätzen die mehr als ein Byte pro zeichen erwarten zu verwenden, führt zu unvorhersehbaren Ergebnissen.

  Variablen werden auf einen für den Spezifizier passenden Typen umgewandelt:

  Typ-Behandlung
  Typ | Spezifizierer
  --- | ---
  string | `s`
  int | `d`, `u`, `c`, `o`, `x`, `X`, `b`
  float | `e`, `E`, `f`, `F`, `g`, `G`, `h`, `H`

`values`

### Rückgabewerte

Gibt eine anhand des Formatierungs-Strings `format` gebildete Zeichenkette zurück.

### Fehler/Exceptions

Wenn die Anzahl der Argumente Null ist, wird seit PHP 8.0.0 ein ValueError ausgelöst. Vor PHP 8.0.0 wurde stattdessen eine `E_WARNING` ausgegeben.

Wenn `[width]` kleiner als Null oder größer als `PHP_INT_MAX` ist, wird seit PHP 8.0.0 ein ValueError ausgelöst. Vor PHP 8.0.0 wurde stattdessen eine `E_WARNING` ausgegeben.

Wenn `[precision]` kleiner als Null oder größer als `PHP_INT_MAX` ist, wird seit PHP 8.0.0 ein ValueError ausgelöst. Vor PHP 8.0.0 wurde stattdessen eine `E_WARNING` ausgegeben.

Wenn weniger Argumente angegeben werden als nötig, wird seit PHP 8.0.0 ein ArgumentCountError ausgelöst. Vor PHP 8.0.0 wurde stattdessen `false` zurückgegeben und eine `E_WARNING` ausgegeben.

### Changelog

Version | Beschreibung
--- | ---
8.0.0 | Diese Funktion gibt bei Auftreten eines Fehlers nicht mehr `false` zurück.
8.0.0 | Wenn die Anzahl der Argumente Null ist, löst diese Funktion einen ValueError aus; vorher gab sie stattdessen eine `E_WARNING` aus.
8.0.0 | Wenn `[width]` kleiner als Null oder größer als `PHP_INT_MAX` ist, löst diese Funktion einen ValueError aus; vorher gab sie stattdessen einen `E_WARNING` aus.
8.0.0 | Wenn `[precision]` kleiner als Null oder größer als `PHP_INT_MAX` ist, löst diese Funktion einen ValueError aus; vorher gab sie stattdessen eine `E_WARNING` aus.
8.0.0 | Wenn weniger Argumente angegeben werden als nötig, löst diese Funktion einen ArgumentCountError aus; vorher gab sie stattdessen eine `E_WARNING` aus.

### Beispiele

Beispiel #1 Argumente tauschen

Der Formatstring unterstützt nummerierte Argumente und kann daher auch ihre Position bestimmen (argument numbering/swapping).

    <?php
    $anzahl = 5;
    $ort    = 'Baum';

    $format = 'Es sind %d Affen auf dem %s';
    echo sprintf($format, $anzahl, $ort);
    ?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    Es sind 5 Affen auf dem Baum

Aber nehmen wir einmal an, dass wir den Formatstring in einer separaten Datei erstellen, da wir ihn internationalisieren wollen und deshalb wie folgt umschreiben:

Beispiel #2 Falsche Reihenfolge der Argumente

Der Formatstring unterstützt die Nummerierung/Vertauschung von Argumenten.

    <?php
    $anzahl = 5;
    $ort = 'Baum';

    $format = 'Auf dem %s sind %d Affen';
    echo sprintf($format, $anzahl, $ort);
    ?>

Nun haben wir ein Problem. Die Reihenfolge der Platzhalter im Formatstring entspricht nicht mehr der Reihenfolge der Argumente im Code. Wir würden gern den Code belassen wie er ist und einfach im Formatstring angeben, auf welche Argumente sich die Platzhalter beziehen. Wir würden dann den Formatstring wie folgt schreiben:

Beispiel #3 Verwenden der Reihenfolge bei Platzhaltern

    <?php
    $anzahl = 5;
    $ort = 'Baum';

    $format = 'Auf dem %2$s sind %1$d Affen';
    echo sprintf($format, $anzahl, $ort);
    ?>

Ein weiterer Vorteil ist, dass die Platzhalter wiederholt werden können, ohne mehr Argumente im Code hinzufügen zu müssen.

Beispiel #4 Platzhalter mehrfach verwenden

    <?php
    $anzahl = 5;
    $ort = 'Baum';

    $format = 'Auf dem %2$s sind %1$d Affen.
               %1$d Affen sind ziemlich viel für einen %2$s.';
    echo sprintf($format, $anzahl, $ort);
    ?>

Wenn Argumente vertauscht werden, muss die `n$`-Positionsangabe direkt nach dem Prozentzeichen (`%`) folgen, vor jeglichen anderen Angaben, wie unten zu sehen ist.

Beispiel #5 Angabe von Füllzeichen

    <?php
    echo sprintf("%'.9d\n", 123);
    echo sprintf("%'.09d\n", 123);
    ?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    ......123
    000000123

Beispiel #6 Positionstausch mit weiteren Spezifikatoren

    <?php
    $anzahl = 5;
    $ort = 'Baum';

    $format= 'Auf dem %2$s sind %1$04d Affen';
    echo sprintf($format, $anzahl, $ort);
    ?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    Auf dem Baum sind 0005 Affen.

Beispiel #7 sprintf(): Mit Nullen aufgefüllte Integer

    <?php
    $jahr = 2005;
    $monat = 5;
    $tag = 6;

    $isodatum = sprintf("%04d-%02d-%02d", $jahr, $monat, $tag);
    ?>

Beispiel #8 sprintf(): Währungsformatierung

    <?php
    $betrag1 = 68.75;
    $betrag2 = 54.35;
    $summe = $betrag1 + $betrag2;
    echo $summe, PHP_EOL;

    $formatiert = sprintf("%01.2f", $summe);
    echo $formatiert, PHP_EOL;
    ?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    123.1
    123.10

Beispiel #9 sprintf(): Wissenschaftliche Notation

    <?php
    $zahl = 362525200;

    echo sprintf("%.3e", $zahl), PHP_EOL;
    ?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    3.625e+8

### Siehe auch

- printf() - Liefert einen formatierten String
- fprintf() - Schreibt einen formatierten String in einen Stream
- vprintf() - Gibt einen formatierten String aus
- vsprintf() - Gibt einen formatierten String zurück
- vfprintf() - Schreibt einen formatierten String in einen Stream
- sscanf() - Überträgt einen String in ein angegebenes Format
- fscanf() - Interpretiert den Input einer Datei entsprechend einem angegebenen Format
- number_format() - Formatiert eine Zahl mit Tausender-Trennzeichen
- date() - Formatiert einen Unix-Zeitstempel

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open