関数・クラス解説

fprintf

指定されたフォーマットの文字列をファイルに書き込む

フォーマット

int : fprintf ( resource $handle , string $format , mixed ...$values )

パラメータ

resource $handle
fopen() で作成したファイルポインタリソース。

string $format
フォーマット形式を指定する。以下を参照してください。

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

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

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

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

●Width
(最小で)何文字がこの変換結果に含まれるかを数値で指定します。

●Precision ピリオド . の後に数値を続けますが、 その意味は指定子に依存します:
・e, E, f と F 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は6です)
・g と G 指定子の場合: 表示する最大の有効桁数
・s 指定子の場合: 文字列を切り捨てる時点、つまり、文字列の最大の長さを設定します。

※注意: 明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。
※注意: 位置を示す指定子に、PHP_INT_MAX を超える値を指定すると、警告が発生します。

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

※警告 c 指定子はパディングと幅を無視します
※警告 文字列と width 指定子を、1文字の表現に1バイト以上必要な文字セットと一緒に使おうとすると、 期待しない結果になるかもしれません。

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

型のハンドリング（型 指定子）
string s
integer d, u, c, o, x, X, b
double g, G, e, E, f, F

解説

format によって作成された文字列を handle で指定したストリームに書き込みます。

記述サンプル

//PHP 7.4.6で実行
//ファイルポインタ取得
if (!($fp = fopen('/var/www/html/test.txt', 'w'))) {
	return;
}

$year = 2020;
$month = 11;
$day = 25;

// 指定した日付フォーマットを /var/www/html/test.txt に書き込む
fprintf($fp, '%04d年 %02d月 %02d日', $year, $month, $day);

//結果 /var/www/html/test.txt の内容
2020年 11月 25日

/* ----------------------------- */

//ファイルポインタ取得
if (!($fp = fopen('/var/www/html/test.txt', 'w'))) {
    return;
}

//値をセット
$float = 132.456;

//"約132.45600" をファイルに出力する
$length = fprintf($fp, '約%01.5f', $float);

// fprintf の返り値は書き込まれたバイト数を返却します
echo "$length バイトをファイルに書き込みました";

//結果
約132.45600
12 バイトをファイルに書き込みました

参考リンク

タグ

フォーマット ファイル 操作 書込み String 文字列

公式リファレンス

書式

fprintf ( resource $handle , string $format , mixed ...$values ) : int

説明

format によって作成された文字列を handle で指定したストリームに書き込みます。

パラメータ

handle

fopen()を使用して作成したファイルシステムポインタリソース。

format

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

Argnum

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

フラグ一覧

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

Width

(最小で)何文字がこの変換結果に含まれるかを数値で指定します。

Precision

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

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

注意: 明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。

注意: 位置を示す指定子に、PHP_INT_MAX を超える値を指定すると、警告が発生します。

指定子の一覧

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

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

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

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

型のハンドリング

型	指定子
string	s
integer	d, u, c, o, x, X, b
double	g, G, e, E, f, F

values

返値

書き込まれた文字列の長さを返します。

注意

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

サンプル

例1 fprintf(): 数値のゼロ埋め
 

if (!($fp = fopen('currency.txt', 'w'))) {
    return;
}

fprintf($fp, "%04d-%02d-%02d", $year, $month, $day);
// ISO 形式にフォーマットした日付を date.txt に書き込みます

 
例2 fprintf(): 金額のフォーマット
 

if (!($fp = fopen('date.txt', 'w'))) {
    return;
}

$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
// echo $money は "123.1" を出力します
$len = fprintf($fp, '%01.2f', $money);
// "123.10" を currency.txt に書き込みます

echo "$len バイトを currency.txt に書き込みました";
// fprintf の返り値を使用して、書き込まれたバイト数を取得します

参考

ワード検索

関数名アルファベット別

最終更新一覧

●stristr
　大文字小文字を区別せず文字列を検索し、ヒット箇所以降（あるいは以前）の文字列を返却

●stripslashes
　バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

●stripos
　大文字小文字を区別せずに文字列が最初に現れる位置を取得する

●stripcslashes
　addcslashes() でクォートされた文字列をアンクォートする

●strip_tags
　文字列から HTML と PHP のタグを除去して返却

●strcspn
　指定した文字が最初に現れる位置を調べる

●strcoll
　ロケールに基づいて2つの文字列を比較し同じか（あるいは大小）を判定する

●strcmp
　2つの文字列を比較し同じか（あるいは大小）を判定する

●strchr
　strstr() のエイリアス

●strcasecmp
　2つの文字列を比較（大文字小文字を区別せず同じとみなす）

カテゴリー一覧

PHP の振る舞いの変更
音声フォーマットの操作
認証サービス
コマンドライン関連
圧縮およびアーカイブ
暗号
データベース関連
日付および時刻関連
ファイルシステム
自然言語および文字エンコーディング
画像処理および作成
メール関連
数学
テキスト以外の MIME 型
プロセス制御
その他の基本モジュール
その他のサービス
検索エンジン用の拡張モジュール
サーバー固有のモジュール
セッション関連
テキスト処理
変数・データ型関連
ウェブサービス
Windows 用のモジュール
XML 操作
GUI用の拡張モジュール