(PHP 4, PHP 5, PHP 7)
sprintf — フォーマットされた文字列を返す
フォーマット文字列 format
に基づき生成された文字列を返します。
formatフォーマット文字列は 0 個以上のディレクティブ（指示子） により構成されます。ディレクティブには、そのまま結果にコピーされる (% を除く) 通常の文字と変換指定子 (conversion specifications) があり、 取り出される際はどちらもそれ自身がパラメータとなります。このことは sprintf() の場合だけでなく printf() の場合も同様です。
各変換指定子は、パーセント記号 (%) の後に これらの要素が一つ以上続いたものになります。
型指定子。引数を何の型として扱うかを指定します。 指定できる型を以下に示します。
変数を適切な型に強制することができます。
| 型 | 指定子 |
|---|---|
| string | s |
| integer | d, u, c, o, x, X, b |
| double | g, G, e, E, f, F |
マルチバイト文字列と幅指定を組み合わせて使うと、予期せぬ結果になる可能性があります。
フォーマット文字列における引数の 番号付け/交換 をサポートしています。以下に例を示します。
例1 引数の交換
<?php
$num = 5;
$location = 'tree';
$format = 'There are %d monkeys in the %s';
echo sprintf($format, $num, $location);
?>
例2 引数の交換
<?php
$format = 'The %s contains %d monkeys';
echo sprintf($format, $num, $location);
?>
例3 引数の交換
<?php
$format = 'The %2$s contains %1$d monkeys';
echo sprintf($format, $num, $location);
?>
例4 引数の交換
<?php
$format = 'The %2$s contains %1$d monkeys.
That\'s a nice %2$s full of %1$d monkeys.';
echo sprintf($format, $num, $location);
?>
例5 桁埋め文字の指定
<?php
echo sprintf("%'.9d\n", 123);
echo sprintf("%'.09d\n", 123);
?>
上の例の出力は以下となります。
......123 000000123
例6 位置指定子と他の指定との共用
<?php
$format = 'The %2$s contains %1$04d monkeys';
echo sprintf($format, $num, $location);
?>
上の例の出力は以下となります。
The tree contains 0005 monkeys
注意:
PHP_INT_MAXより大きい位置指定子を指定すると、 sprintf() は警告を発します。
型指定子 c は、パディングや幅指定を無視します。
args
...
フォーマット文字列 format
に基づき生成された文字列を返します。
例7 printf() のさまざまな例
<?php
$n = 43951789;
$u = -43951789;
$c = 65; // ASCII コードの 65 は 'A' です
// %% に注目しましょう。これは、リテラル '%' を文字として出力します
printf("%%b = '%b'\n", $n); // 2 進表現
printf("%%c = '%c'\n", $c); // ascii 文字を表示します。chr() 関数と同じです
printf("%%d = '%d'\n", $n); // 標準の整数表現
printf("%%e = '%e'\n", $n); // 科学記法
printf("%%u = '%u'\n", $n); // 正の整数の、符号なし整数表現
printf("%%u = '%u'\n", $u); // 負の整数の、符号なし整数表現
printf("%%f = '%f'\n", $n); // 浮動小数点表現
printf("%%o = '%o'\n", $n); // 8 進表現
printf("%%s = '%s'\n", $n); // 文字列表現
printf("%%x = '%x'\n", $n); // 16 進表現 (小文字)
printf("%%X = '%X'\n", $n); // 16 進表現 (大文字)
printf("%%+d = '%+d'\n", $n); // 正の整数に符号指定子を使用
printf("%%+d = '%+d'\n", $u); // 負の整数に符号指定子を使用
?>
上の例の出力は以下となります。
%b = '10100111101010011010101101' %c = 'A' %d = '43951789' %e = '4.39518e+7' %u = '43951789' %u = '4251015507' %f = '43951789.000000' %o = '247523255' %s = '43951789' %x = '29ea6ad' %X = '29EA6AD' %+d = '+43951789' %+d = '-43951789'
例8 printf() の文字列指定子
<?php
$s = 'monkey';
$t = 'many monkeys';
printf("[%s]\n", $s); // 標準の文字列出力
printf("[%10s]\n", $s); // 空白を使用して右詰め
printf("[%-10s]\n", $s); // 空白を使用して左詰め
printf("[%010s]\n", $s); // ゼロ埋めは文字列でも可能です
printf("[%'#10s]\n", $s); // ゼロの代わりに独自の文字 '#' で埋めます
printf("[%10.10s]\n", $t); // 左詰めを行い、10 文字以上は切り捨てます
?>
上の例の出力は以下となります。
[monkey] [ monkey] [monkey ] [0000monkey] [####monkey] [many monke]
例9 sprintf(): 整数のゼロ埋め
<?php
$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);
?>
例10 sprintf(): 通貨をフォーマットする例
<?php
$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
// echo $money は "123.1" を出力します。
$formatted = sprintf("%01.2f", $money);
// echo $formatted は "123.10"を出力します
?>
例11 sprintf(): 科学記法
<?php
$number = 362525200;
echo sprintf("%.3e", $number); // 3.625e+8 を出力します
?>