PHP sprintf(): Format String, Padding, dan Angka Desimal

sprintf() mengembalikan string yang disusun dari sebuah format dan daftar nilai: setiap placeholder % di format diganti dengan nilai berikutnya. sprintf('%s is %d years old', 'Ada', 36) mengembalikan "Ada is 36 years old". printf() menerima argumen yang sama, tetapi mencetak hasilnya alih-alih mengembalikannya.

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

Placeholder diisi secara berurutan, dari kiri ke kanan. %.2f selalu menampilkan dua angka desimal (4.50, bukan 4.5), dan %05d menambahkan nol di depan angka sampai lima digit.

Format specifier

Sebuah placeholder terdiri dari %, modifier opsional, lalu satu huruf untuk tipenya:

Ubah nilai di bawah ini lalu jalankan lagi:

<?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 memotong float ke arah nol, jadi 42.9 menjadi 42. Kalau kamu ingin 43, bulatkan dulu: sprintf('%d', round(42.9)). String yang bukan angka, seperti 'abc', menjadi 0 di bawah %d.

Padding dengan nol di depan

Di antara % dan hurufnya, kamu bisa menaruh karakter padding dan lebar. %05d berarti "isi dengan 0 sampai lebar 5". Inilah cara yang biasa dipakai untuk memformat nomor pesanan, ID invoice, waktu, dan tanggal.

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

Lebar ini adalah batas minimum. Angka yang lebih panjang dari lebarnya tetap dicetak utuh.

%05.2f: lebar dan desimal sekaligus

Pada float, lebar menghitung setiap karakter hasilnya, termasuk titik desimal dan tanda minus. Itulah sebabnya %05.2f pada 3.14159 menghasilkan 03.14: total lima karakter, dua di antaranya setelah titik.

<?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 memakai pemisah desimal dari locale yang sedang aktif (diatur dengan setlocale()), sedangkan %F selalu memakai titik. Kalau kodemu mengatur locale dan kamu butuh titik untuk JSON, CSV, atau API, pakai %F.

Meratakan teks dalam kolom

Lebar positif meratakan ke kanan, tanda - sebelum lebar meratakan ke kiri, dan ' yang diikuti sebuah karakter menentukan karakter padding sendiri. Kalau digabung, semuanya bisa merapikan laporan dan struk dalam teks biasa.

<?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 menambahkan padding di kanan nama barang sampai 14 karakter, %8.2f meratakan harga ke kanan dalam 8 karakter, dan %'-27s dengan string kosong mencetak garis berisi 27 tanda hubung. %'*10s memakai * sebagai padding, bukan spasi.

Memberi nomor pada argumen untuk dipakai ulang atau diubah urutannya

%1$s berarti "argumen pertama sebagai string", %2$d berarti "argumen kedua sebagai integer". Placeholder bernomor membuatmu bisa memakai sebuah nilai dua kali atau mengubah urutannya tanpa mengubah daftar argumen, dan ini dibutuhkan penerjemah saat urutan kata berbeda antarbahasa.

<?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, dan nilai kembaliannya

vsprintf() menerima nilai-nilainya sebagai satu array, yang praktis kalau nilai itu memang sudah ada di sebuah array. printf() mengembalikan jumlah byte yang dicetaknya, dan vprintf() adalah versi array dari 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);

Jumlah dari printf() ikut menghitung baris barunya, jadi "Hello\n" adalah 6 byte. Untuk teks multibyte, yang dihitung adalah byte, bukan karakter.

Argumen yang kurang memunculkan error

Sejak PHP 8, format yang placeholder-nya lebih banyak daripada nilainya akan melempar ArgumentCountError, bukan mengembalikan false. Hitung placeholder % (abaikan %%) saat kamu melihat error ini.

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

Pesan error-nya menghitung string format sebagai sebuah argumen: ArgumentCountError: 4 arguments are required, 3 given. Argumen yang berlebih diabaikan tanpa pemberitahuan, jadi kesalahan sebaliknya tidak muncul sebagai error. Kalau hasil sprintf terlihat salah, cetak format-nya di samping nilai-nilainya. Kalau yang kamu butuhkan hanya pemisah ribuan, number_format() lebih sederhana daripada menyusunnya dengan sprintf. Daftar lengkap modifier ada di php.net.