PHPのvsprintf()関数とは？構文・書式指定子・使用例を徹底解説

PHPのvsprintf()関数は、フォーマット（書式）文字列に基づいて整形された文字列を返す関数です。sprintf()関数とよく似ていますが、引数を個別に渡すのではなく、配列としてまとめて渡す点が大きな特徴です。

基本構文

vsprintf(format, argarray)

パラメータ

• format ― 文字列と、その中で変数をどのように整形するかを指定します。

formatに指定できる主な書式指定子は以下の通りです。

• %% ― パーセント記号（%）そのものを返します

• %b ― 2進数

• %c ― ASCII値に対応する文字

• %d ― 符号付き10進数（負・ゼロ・正）

• %e ― 小文字の指数表記による科学技術表記（例：1.2e+2）

• %E ― 大文字の指数表記による科学技術表記（例：1.2E+2）

• %u ― 符号なし10進数（ゼロ以上）

• %f ― 浮動小数点数（ロケール設定を考慮）

• %F ― 浮動小数点数（ロケール設定を考慮しない）

• %g ― %e と %f のうち短い方

• %G ― %E と %f のうち短い方

• %o ― 8進数

• %s ― 文字列

• %x ― 16進数（小文字）

• %X ― 16進数（大文字）

• argarray ― フォーマット文字列内の「%」記号の位置に挿入される値を格納した配列を指定します。

戻り値

vsprintf()関数は、指定された書式に従って整形された文字列を返します。なお、直接出力は行わないため、表示したい場合はechoやprintなどで出力する必要があります。

使用例

以下はvsprintf()関数を使った具体的なコード例です。

<?php
$a = 6567;
$b = 8976;
$res = vsprintf("%f\n%f", array($a, $b));
echo $res;
?>

実行結果

6567.000000
8976.000000

この例では、変数$aと$bの値が配列として渡され、それぞれ「%f」の位置に浮動小数点数として整形されて出力されます。このように、複数の値を一度に整形したい場合にvsprintf()関数は非常に便利です。