PHP sprintf(): форматирование строк, нули и знаки

sprintf() возвращает строку, собранную из формата и списка значений: каждый плейсхолдер % в формате заменяется следующим значением. sprintf('%s is %d years old', 'Ada', 36) возвращает "Ada is 36 years old". printf() принимает те же аргументы, но печатает результат, а не возвращает его.

<?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);

Плейсхолдеры заполняются по порядку, слева направо. %.2f всегда показывает два знака после запятой (4.50, а не 4.5), а %05d дополняет число нулями до пяти цифр.

Спецификаторы формата

Плейсхолдер это %, необязательные модификаторы и одна буква типа:

Измените значения ниже и запустите снова:

<?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 отбрасывает дробную часть float в сторону нуля, поэтому 42.9 превращается в 42. Если нужно 43, сначала округлите: sprintf('%d', round(42.9)). Строка, которая не является числом, например 'abc', под %d становится 0.

Дополнение ведущими нулями

Между % и буквой можно поставить символ дополнения и ширину. %05d означает "дополнить символом 0 до ширины 5". Это обычный способ форматировать номера заказов, ID счетов, время и даты.

<?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";

Ширина это минимум. Число длиннее ширины выводится целиком.

%05.2f: ширина и знаки после запятой вместе

У float ширина учитывает каждый символ результата, включая десятичную точку и знак минус. Поэтому %05.2f для 3.14159 даёт 03.14: всего пять символов, два из них после точки.

<?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 использует десятичный разделитель текущей локали (задаётся через setlocale()), а %F всегда ставит точку. Если ваш код устанавливает локаль, а для JSON, CSV или API нужна точка, используйте %F.

Выравнивание текста по столбцам

Положительная ширина выравнивает по правому краю, - перед шириной выравнивает по левому, а ' с символом после него задаёт свой символ дополнения. Вместе они выстраивают текстовые отчёты и чеки.

<?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 дополняет название товара справа до 14 символов, %8.2f выравнивает цену по правому краю в 8 символах, а %'-27s с пустой строкой печатает линию из 27 дефисов. %'*10s дополняет символом * вместо пробелов.

Нумерация аргументов для повтора и перестановки

%1$s означает "первый аргумент как строка", %2$d "второй как целое число". Пронумерованные плейсхолдеры позволяют использовать значение дважды или поменять порядок, не меняя список аргументов, а это нужно переводчикам, когда порядок слов в языках разный.

<?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 и возвращаемые значения

vsprintf() принимает значения одним массивом, что удобно, когда они уже лежат в массиве. printf() возвращает число выведенных байтов, а vprintf() это версия 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);

Счёт от printf() включает перенос строки, поэтому "Hello\n" это 6 байтов. Для многобайтового текста считаются байты, а не символы.

Слишком мало аргументов вызывает ошибку

Начиная с PHP 8 формат, в котором плейсхолдеров больше, чем значений, выбрасывает ArgumentCountError, а не возвращает false. Увидев эту ошибку, посчитайте плейсхолдеры % (не учитывая %%).

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

Сообщение считает и строку формата аргументом: ArgumentCountError: 4 arguments are required, 3 given. Лишние аргументы молча игнорируются, поэтому обратная ошибка никак не проявляется. Если результат sprintf выглядит неправильно, выведите формат рядом со значениями. Когда нужен только разделитель тысяч, number_format() проще, чем собирать его через sprintf. Полный список модификаторов есть на php.net.