sprintf() w PHP: formatowanie, zera i miejsca po przecinku

sprintf() zwraca string zbudowany z formatu i listy wartości: każde miejsce % w formacie zostaje zastąpione kolejną wartością. sprintf('%s is %d years old', 'Ada', 36) zwraca "Ada is 36 years old". printf() przyjmuje te same argumenty, ale wypisuje wynik zamiast go zwracać.

<?php
$name = 'Ada';
$age = 36;
$price = 4.5;

$line = sprintf('%s is %d years old', $name, $age);
echo $line, "\n";

// Two decimals, always
echo sprintf('Total: %.2f EUR', $price), "\n";

// printf prints directly
printf("Order #%05d for %s\n", 42, $name);

Miejsca są wypełniane po kolei, od lewej do prawej. %.2f zawsze pokazuje dwa miejsca po przecinku (4.50, a nie 4.5), a %05d dopełnia liczbę zerami do pięciu cyfr.

Specyfikatory formatu

Miejsce to %, opcjonalne modyfikatory, a potem jedna litera oznaczająca typ:

Zmień wartości poniżej i uruchom ponownie:

<?php
echo sprintf('%s', 'PHP'), "\n";
echo sprintf('%d', 42.9), "\n";      // the decimals are cut off, not rounded
echo sprintf('%f', 1.5), "\n";
echo sprintf('%.2f', 1.5), "\n";
echo sprintf('%e', 1234.5678), "\n";
echo sprintf('%x %X', 255, 255), "\n";
echo sprintf('%o', 8), "\n";
echo sprintf('%b', 5), "\n";
echo sprintf('%08b', 5), "\n";       // binary padded to 8 bits
echo sprintf('%c', 65), "\n";
echo sprintf('%d%%', 50), "\n";
echo sprintf('%+d %+d', 5, -5), "\n"; // always show the sign

%d obcina liczbę zmiennoprzecinkową w stronę zera, więc 42.9 staje się 42. Jeśli chcesz 43, najpierw zaokrąglij: sprintf('%d', round(42.9)). String, który nie jest liczbą, na przykład 'abc', przy %d staje się 0.

Dopełnianie zerami wiodącymi

Między % a literą możesz umieścić znak dopełnienia i szerokość. %05d oznacza „dopełnij znakiem 0 do szerokości 5”. To zwykły sposób formatowania numerów zamówień, identyfikatorów faktur, godzin i dat.

<?php
echo sprintf('%05d', 42), "\n";         // 00042
echo sprintf('%03d', 7), "\n";          // 007
echo sprintf('INV-%06d', 1234), "\n";   // INV-001234

// Times and dates from numbers
$h = 9; $m = 5; $s = 3;
echo sprintf('%02d:%02d:%02d', $h, $m, $s), "\n";
echo sprintf('%04d-%02d-%02d', 2026, 3, 14), "\n";

// A width smaller than the number never cuts it
echo sprintf('%03d', 123456), "\n";

Szerokość jest minimum. Liczba dłuższa niż szerokość zostaje wypisana w całości.

%05.2f: szerokość i miejsca po przecinku razem

Przy liczbach zmiennoprzecinkowych szerokość liczy każdy znak wyniku, w tym kropkę dziesiętną i znak minus. Dlatego %05.2f dla 3.14159 daje 03.14: łącznie pięć znaków, z czego dwa po kropce.

<?php
$pi = 3.14159;

echo sprintf('%05.2f', $pi), "\n";   // 5 characters in total
echo sprintf('%08.2f', $pi), "\n";   // 8 characters in total
echo sprintf('%.2f', $pi), "\n";     // no width, just 2 decimals
echo sprintf('%.0f', $pi), "\n";     // no decimals
echo sprintf('%.2f', 5), "\n";       // integers get decimals too
echo sprintf('%08.2f', -3.5), "\n";  // the minus sign counts

%f używa separatora dziesiętnego z bieżącego locale (ustawianego przez setlocale()), a %F zawsze używa kropki. Jeśli twój kod ustawia locale (na przykład polskie, z przecinkiem), a potrzebujesz kropki dla JSON, CSV lub API, użyj %F.

Wyrównanie tekstu w kolumnach

Dodatnia szerokość wyrównuje do prawej, - przed szerokością wyrównuje do lewej, a ' z następującym po nim znakiem ustawia własny znak dopełnienia. Razem pozwalają ułożyć raporty tekstowe i paragony.

<?php
$items = [
    ['Coffee', 2, 3.5],
    ['Croissant', 1, 2.25],
    ['Orange juice', 3, 4],
];

printf("%-14s %3s %8s\n", 'Item', 'Qty', 'Price');
printf("%'-27s\n", '');

$total = 0;
foreach ($items as [$name, $qty, $price]) {
    $line = $qty * $price;
    $total += $line;
    printf("%-14s %3d %8.2f\n", $name, $qty, $line);
}

printf("%'-27s\n", '');
printf("%-14s %12.2f\n", 'Total', $total);
printf("[%'*10s]\n", 'stars');

%-14s dopełnia nazwę pozycji z prawej do 14 znaków, %8.2f wyrównuje cenę do prawej w 8 znakach, a %'-27s z pustym stringiem wypisuje linię 27 myślników. %'*10s dopełnia znakiem * zamiast spacji.

Numerowanie argumentów do ponownego użycia lub zmiany kolejności

%1$s oznacza „pierwszy argument jako string”, a %2$d „drugi jako liczba całkowita”. Numerowane miejsca pozwalają użyć wartości dwa razy albo zmienić kolejność bez zmiany listy argumentów, czego potrzebują tłumacze, gdy szyk zdania różni się między językami.

<?php
// Single quotes: in double quotes PHP would read $s as a variable
$format = '%1$s has %2$d new messages. Open them, %1$s?';
echo sprintf($format, 'Ada', 3), "\n";

// Same arguments, different order in the sentence
$en = 'Page %1$d of %2$d';
$ja = '全%2$dページ中%1$dページ目';
echo sprintf($en, 2, 10), "\n";
echo sprintf($ja, 2, 10), "\n";

// Modifiers go after the $
echo sprintf('%1$05.1f / %1$.3f', 2.71828), "\n";

vsprintf, printf i wartości zwracane

vsprintf() przyjmuje wartości jako jedną tablicę, co przydaje się, gdy już są w tablicy. printf() zwraca liczbę wypisanych bajtów, a vprintf() to tablicowa wersja printf().

<?php
$row = ['Ada', 'Lovelace', 1815];
echo vsprintf("%s %s was born in %d.\n", $row);

$bytes = printf("%s\n", 'Hello');
echo "printf printed $bytes bytes\n";

// Same result, two ways
echo sprintf('%.1f%%', 12.345), "\n";
printf("%.1f%%\n", 12.345);

Liczba z printf() obejmuje znak nowej linii, więc "Hello\n" to 6 bajtów. Dla tekstu wielobajtowego liczy bajty, a nie znaki.

Za mało argumentów rzuca błąd

Od PHP 8 format z większą liczbą miejsc niż wartości rzuca ArgumentCountError zamiast zwracać false. Gdy zobaczysz ten błąd, policz miejsca % (pomijając %%).

<?php
// This throws an ArgumentCountError on purpose: 3 placeholders, 2 values
echo sprintf('%s bought %d items for %.2f', 'Ada', 3);

Komunikat liczy string formatu jako argument: ArgumentCountError: 4 arguments are required, 3 given. Nadmiarowe argumenty są po cichu ignorowane, więc odwrotny błąd nie pojawia się jako błąd. Jeśli wynik sprintf wygląda źle, wypisz format obok wartości. Gdy potrzebujesz tylko separatora tysięcy, number_format() jest prostsze niż budowanie go przez sprintf. Pełną listę modyfikatorów znajdziesz na php.net.