PHPのvfprintf()関数の使い方を徹底解説！書式付き文字列をストリームへ出力する方法

vfprintf()関数とは

PHPのvfprintf()関数は、書式を指定した文字列（フォーマット済み文字列）を、ファイルやソケットなど特定の出力先（ストリーム）に書き込むための関数です。処理が成功すると、出力された文字列の長さを戻り値として返します。

なお、似た関数として個別の引数を受け取るfprintf()がありますが、vfprintf()は引数を配列としてまとめて渡せる点が特徴です。配列に格納された複数の値を一度に扱いたい場合に便利です。

基本構文

vfprintf(stream, format, arg)

パラメータの詳細

• stream − 文字列を出力する先（ファイルポインタなど）を指定します。
• format − 出力する文字列と、その中で変数をどのように整形するかを指定します。
• arg − 書式文字列内の「%」記号に対応して挿入される値を含む配列を指定します。

formatで使える主な書式指定子

戻り値

vfprintf()関数は、正常に処理が行われた場合、出力された文字列の長さ（バイト数）を整数で返します。

使用例

以下は、書式「%f%f」を使って2つの数値をファイルに書き込むサンプルコードです。

<?php
$str1 = 123;
$str2 = 456;
$file = fopen("sample.txt", "r");
vfprintf($file, "%f%f", array($str1, $str2));
?>

この例では、配列に格納した$str1と$str2の値が、%f（浮動小数点数）の形式に変換され、開いたファイルsample.txtに対して順番に書き込まれます。

実行結果（sample.txtの内容）

123.000000456.000000

まとめ

vfprintf()関数は、printf系の書式指定機能を活かしながら、結果を画面ではなく任意のストリーム（ファイルなど）へ直接出力したい場合に活躍します。引数を配列で渡せるため、可変長のデータをまとめてフォーマットする際にも柔軟に対応できるのが魅力です。ログファイルへの整形済みデータの書き込みなど、実用的な場面でぜひ活用してみてください。