printf

(PHP 4, PHP 5, PHP 7, PHP 8)

printf — フォーマット済みの文字列を出力する

説明

printf(string $format, mixed ...$values): int

format にしたがって、出力を生成します。

パラメータ

format

0個以上のディレクティブで構成されるフォーマット文字列: 変換結果に直接コピーされる通常文字列 (% は除きます) と、変換仕様。これらのいずれも、自分が持つパラメータを取得します。

変換の仕様は、以下のプロトタイプに従います: %[argnum$][flags][width][.precision]specifier.

Argnum

何番目の引数を変換の対象にするかを指定するために、数値の後にドル記号 $ を続けます。

**フラグ一覧**
フラグ	説明
`-`	与えられたフィールドの幅を左寄せにします。右寄せがデフォルトです。
`+`	正の数値の前に付ける `+` 符号です; デフォルトは、負の数にだけマイナスの符号が数値の前に付きます。
(space)	スペースに変換される詰め物です。これがデフォルトです。
`0`	数値の左側を0埋めします。 `s` 指定子を使うと、右側にも0埋めできます。
`'`(char)	指定された (char) で埋めます。

Width

(最小で)何文字がこの変換結果に含まれるかを数値で指定するか、 * を指定します。 * を指定した場合、指定子によってフォーマットされる値の前に、幅を追加の数値として指定します。

Precision

ピリオド . の後に数値を続けるか、 * を続けますが、その意味は指定子に依存します:

e, E, f と F 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は6です)
g, G, h, H 指定子の場合: 表示する最大の有効桁数
s 指定子の場合: 文字列を切り捨てる時点、つまり、文字列の最大の長さを設定します。

注意: 明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。 * を使った場合、精度は指定子によってフォーマットされる値の前に、追加の数値として指定します。

**指定子の一覧**
指定子	説明
`%`	文字通り、パーセント文字です。引数は不要です。
`b`	引数は整数として扱われ、2進数値として表現されます。
`c`	引数は整数として扱われ、ASCII文字として表現されます。
`d`	引数は整数として扱われ、(符号付き)10進数値として表現されます。
`e`	引数は科学的記法で表現された値(e.g. 1.2e+2)として扱われます。
`E`	`e` 指定子に似ていますが、大文字を使います(e.g. 1.2E+2)
`f`	引数は小数として扱われ、浮動小数点数値として表現されます(ロケールを考慮します)。
`F`	引数は小数として扱われ、浮動小数点数値として表現されます(ロケールを考慮しません)。
`g`	汎用フォーマット P を精度を表す、ゼロでない値とします。精度が省略された場合、Pの値は6です。精度に0を指定した場合、Pの値は1になります。この場合、 `E` 指定子の変換結果は、 X乗になります。 P > X ≥ −4 の場合、`E` 指定子の変換結果となり、精度は、P − (X + 1) になります。そうでない場合、`e` 指定子の変換結果となり、精度は、P - 1 になります。
`G`	`g` 指定子に似ていますが、 `E` と `f` を使います。
`h`	`g` 指定子に似ていますが、 `F` を使います。 PHP 8.0.0 以降で利用可能です。
`H`	`g` 指定子に似ていますが、 `E` と `F` を使います。 PHP 8.0.0 以降で利用可能です。
`o`	引数は整数として扱われ、8進数値として表現されます。
`s`	引数は文字列として扱われ、文字列として表現されます。
`u`	引数は整数として扱われ、符号なし10進数値として表現されます。
`x`	引数は整数として扱われ、16進数値(小文字)として表現されます。
`X`	引数は整数として扱われ、16進数値(大文字)として表現されます。

警告

c 指定子はパディングと幅を無視します

警告

文字列と width 指定子を、1文字の表現に1バイト以上必要な文字セットと一緒に使おうとすると、期待しない結果になるかもしれません。

値は、指定子の型に合うように強制されます:

**型のハンドリング**
型	指定子
string	`s`
int	`d`, `u`, `c`, `o`, `x`, `X`, `b`
float	`e`, `E`, `f`, `F`, `g`, `G`, `h`, `H`

values

戻り値

出力した文字列の長さを返します。

エラー / 例外

　PHP 8.0.0 以降では、引数の数が0の場合に ValueError がスローされます。これより前のバージョンでは、代わりに E_WARNING を発生させていました。

PHP 8.0.0 以降では、 [width] の値が0より小さかったり、 PHP_INT_MAX より大きい場合に、 ValueError がスローされます。これより前のバージョンでは、代わりに E_WARNING を発生させていました。

PHP 8.0.0 以降では、 [precision] の値が0より小さかったり、 PHP_INT_MAX より大きい場合に、 ValueError がスローされます。これより前のバージョンでは、代わりに E_WARNING を発生させていました。

PHP 8.0.0 以降では、引数が必要な数より少なかった場合、 ArgumentCountError がスローされます。これより前のバージョンでは、代わりに false を返し、E_WARNING を発生させていました。

変更履歴

バージョン	説明
8.0.0	この関数は、失敗時に `false` を返さなくなりました。
8.0.0	引数の数が0だった場合、 ValueError がスローされるようになりました。これより前のバージョンでは、代わりに `E_WARNING` を発生させていました。
8.0.0	`[width]` の値が0より小さかったり、 `PHP_INT_MAX` より大きい場合に、 ValueError をスローするようになりました。これより前のバージョンでは、代わりに `E_WARNING` を発生させていました。
8.0.0	`[precision]` の値が0より小さかったり、 `PHP_INT_MAX` より大きい場合に、 ValueError をスローするようになりました。これより前のバージョンでは、代わりに `E_WARNING` を発生させていました。
8.0.0	引数が必要な数より少なかった場合、 ArgumentCountError がスローされるようになりました。これより前のバージョンでは、代わりに `E_WARNING` を発生させていました。

例

例1 printf(): の様々な例

<?php
$n =  43951789;
$u = -43951789;
$c = 65; // ASCII の 65番目は 'A'

// %% は、リテラル '%' 文字を出力することに注意
printf("%%b = '%b'\n", $n); // バイナリ表現
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'

例2 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("[%'#*s]\n", 10, $s); // 追加の引数を指定し、文字埋めの幅を指定
printf("[%10.9s]\n",    $t); // 右寄せ。但し8文字で切り捨て
printf("[%-10.9s]\n",   $t); // 左寄せ。但し8文字で切り捨て
?>

上の例の出力は以下となります。

[monkey]
[    monkey]
[monkey    ]
[0000monkey]
[####monkey]
[####monkey]
[ many monk]
[many monk ]

参考

print - 文字列を出力する
sprintf() - フォーマットされた文字列を返す
fprintf() - フォーマットされた文字列をストリームに書き込む
vprintf() - フォーマットされた文字列を出力する
vsprintf() - フォーマットされた文字列を返す
vfprintf() - フォーマットされた文字列をストリームに書き込む
sscanf() - フォーマット文字列に基づき入力を処理する
fscanf() - フォーマットに基づきファイルからの入力を処理する
number_format() - 数字を千の位毎にグループ化してフォーマットする
date() - Unixタイムスタンプを書式化する
flush() - システム出力バッファをフラッシュする

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 7 notes

down

dhosek at excite dot com ¶

25 years ago

Be careful:

printf ("(9.95 * 100) = %d \n", (9.95 * 100));



'994'



First %d converts a float to an int by truncation.



Second floats are notorious for tiny little rounding errors.

down

php at mole dot gnubb dot net ¶

19 years ago

[Editor's Note: Or just use vprintf...]



If you want to do something like <?php printf('There is a difference between %s and %s', array('good', 'evil')); ?> (this doesn't work)  instead of <?php printf('There is a difference between %s and %s', 'good', 'evil'); ?> you can use this function:



<?php

function printf_array($format, $arr)

{

    return call_user_func_array('printf', array_merge((array)$format, $arr));

}

?>



Use it the following way:

<?php

$goodevil = array('good', 'evil');

printf_array('There is a difference between %s and %s', $goodevil);

?>

and it will print:

There is a difference between good and evil

down

simon dot patrick at cantab dot net ¶

3 months ago

A few things to note about printf:
1. The definition of specifier g (or G) is often wrongly stated as being "use e or f (or E or f), whichever results in the shorter string". The correct rule is given in the documentation and it does not always give this result. 
2. For g/G/h/H, trailing zeros after the decimal point are removed (but not a zero just after the decimal point, in the e/E style).
3. g/G are locale-aware whether the e/E or f style is produced.
4. For b/o/x/X/u (that is, all integer styles except d) the result shown for negative values is the twos complement form of the number, 2**32 + v, where v is the (negative) value.

down

deekayen at hotmail dot com ¶

23 years ago

You can use this function to format the decimal places in a number:



$num = 2.12;

printf("%.1f",$num);



prints:



2.1



see also: number_format()

down

-1

maybird99 at yahoo dot com ¶

22 years ago

instead of writing a function to round off a float (let's call it 'x') accurately, it's much easier to add a small number to x and then truncate it...
For example: if you want to round off to the nearest integer, just add 0.5 to x and then truncate it. if x=12.6, then it would calculate 13.1, and truncate it to 13. If x=14.4, it would calculate 14.9 and truncate it to 14.

down

-1

Mario M. Junior ¶

2 years ago

To provide a more user-friendly interface, you can use colors when printing text in the terminal.

p('Ordinary text.');
p('Warning: Check this out...', 'info');
p('Ops! Something went wrong.', 'error');
p('Yeah... done!', 'success');

function p($text, $style = '', $newLine = true) {

    $styles = array(
        'success' => "\033[0;32m%s\033[0m",
        'error'   => "\033[31;31m%s\033[0m",
        'info'    => "\033[33;33m%s\033[0m",

        'Black'    => "\033[0;30m%s\033[0m",
        'Red'      => "\033[0;31m%s\033[0m",
        'Green'    => "\033[0;32m%s\033[0m",
        'Yellow'   => "\033[0;33m%s\033[0m",
        'Blue'     => "\033[0;34m%s\033[0m",
        'Purple'   => "\033[0;35m%s\033[0m",
        'Cyan'     => "\033[0;36m%s\033[0m",
        'Gray'     => "\033[0;37m%s\033[0m",
        'Graphite' => "\033[1;30m%s\033[0m",

        'Bold Red'    => "\033[1;31m%s\033[0m",
        'Bold Green'  => "\033[1;32m%s\033[0m",
        'Bold Yellow' => "\033[1;33m%s\033[0m",
        'Bold Blue'   => "\033[1;34m%s\033[0m",
        'Bold Purple' => "\033[1;35m%s\033[0m",
        'Bold Cyan'   => "\033[1;36m%s\033[0m",
        'Bold White'  => "\033[1;37m%s\033[0m",

        'Bg Black'  => "\033[40;1;37m%s\033[0m",
        'Bg Red'    => "\033[41;1;37m%s\033[0m",
        'Bg Green'  => "\033[42;1;37m%s\033[0m",
        'Bg Yellow' => "\033[43;1;37m%s\033[0m",
        'Bg Blue'   => "\033[44;1;37m%s\033[0m",
        'Bg Purple' => "\033[45;1;37m%s\033[0m",
        'Bg Cyan'   => "\033[46;1;37m%s\033[0m",
        'Bg Gray'   => "\033[47;1;37m%s\033[0m",

        'Underscore' => "\033[4;37m%s\033[0m",
        'Inverted'   => "\033[7;37m%s\033[0m",
        'Blink'      => "\033[5;37m%s\033[0m",
    );

    $format = '%s';

    if (isset($styles[$style])) {
        $format = $styles[$style];
    }

    if ($newLine) {
        $format .= PHP_EOL;
    }

    printf($format, $text);
}

down

-5

steve at myschoolsystems dot com ¶

3 years ago

To format a dollar value as in $123.00 that may otherwise look like $123  use this

print ('$');                    // the dollar sign in front of our answer
printf ('%.2f',$price);

＋add a note