PHP sprintf(): formatar strings, zeros à esquerda e decimais

O sprintf() retorna uma string montada a partir de um formato e de uma lista de valores: cada marcador % no formato é substituído pelo próximo valor. sprintf('%s is %d years old', 'Ada', 36) retorna "Ada is 36 years old". O printf() recebe os mesmos argumentos, mas imprime o resultado em vez de retorná-lo.

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

Os marcadores são preenchidos em ordem, da esquerda para a direita. %.2f sempre mostra duas casas decimais (4.50, não 4.5), e %05d completa o número com zeros até cinco dígitos.

Os especificadores de formato

Um marcador é %, modificadores opcionais e depois uma letra para o tipo:

Mude os valores abaixo e rode de novo:

<?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 trunca um float em direção ao zero, então 42.9 vira 42. Se você quer 43, arredonde antes: sprintf('%d', round(42.9)). Uma string que não é número, como 'abc', vira 0 com %d.

Completar com zeros à esquerda

Entre o % e a letra você pode colocar um caractere de preenchimento e uma largura. %05d significa "completar com 0 até a largura 5". É o jeito comum de formatar números de pedido, IDs de nota fiscal, horários e datas.

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

A largura é um mínimo. Um número maior que a largura é impresso por inteiro.

%05.2f: largura e casas decimais juntas

Com floats, a largura conta cada caractere do resultado, incluindo o ponto decimal e o sinal de menos. É por isso que %05.2f em 3.14159 dá 03.14: cinco caracteres no total, dois deles depois do ponto.

<?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 usa o separador decimal do locale atual (definido com setlocale()), enquanto %F sempre usa ponto. Se o seu código define um locale e você precisa de ponto para JSON, CSV ou uma API, use %F.

Alinhar texto em colunas

Uma largura positiva alinha à direita, um - antes da largura alinha à esquerda, e ' seguido de um caractere define um caractere de preenchimento personalizado. Combinados, eles alinham relatórios e recibos em texto puro.

<?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 completa o nome do item à direita até 14 caracteres, %8.2f alinha o preço à direita em 8 caracteres, e %'-27s com uma string vazia imprime uma linha de 27 traços. %'*10s completa com * em vez de espaços.

Numerar os argumentos para reutilizá-los ou reordená-los

%1$s significa "o primeiro argumento como string", %2$d "o segundo como inteiro". Marcadores numerados deixam você usar um valor duas vezes ou mudar a ordem sem alterar a lista de argumentos, o que tradutores precisam quando a ordem das palavras muda entre idiomas.

<?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 e os valores de retorno

O vsprintf() recebe os valores como um único array, o que é prático quando eles já estão num array. O printf() retorna o número de bytes que imprimiu, e o vprintf() é a versão com array do 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);

A contagem do printf() inclui a quebra de linha, então "Hello\n" tem 6 bytes. Para texto multibyte, ela conta bytes, não caracteres.

Poucos argumentos lança um erro

Desde o PHP 8, um formato com mais marcadores do que valores lança um ArgumentCountError em vez de retornar false. Conte os marcadores % (ignorando %%) quando vir esse erro.

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

A mensagem conta a string de formato como argumento: ArgumentCountError: 4 arguments are required, 3 given. Argumentos a mais são ignorados em silêncio, então o erro oposto não aparece como erro. Se um resultado do sprintf parecer errado, imprima o formato ao lado dos valores. Quando você só precisa de um separador de milhar, o number_format() é mais simples do que montar um com sprintf. A lista completa de modificadores está no php.net.