関数の概要
PHPの fwrite 関数は、開いたファイルポインタに対して文字列を書き込むための関数です。ファイルに新しいデータを追加したり、既存の内容を書き換えたりする際によく使われます。主にテキストファイルやバイナリファイルへの書き込みに活用され、効率的にファイル操作を行うことができます。
パラメータの説明
resource $handle— 書き込み対象となるファイルポインタ。fopenなどで開いたものを指定します。string $string— ファイルに書き込む文字列です。int|null $length— オプション。書き込む最大バイト数を指定します。省略すると文字列全体を書き込みます。
戻り値
fwrite は実際に書き込まれたバイト数を返します。書き込みに失敗した場合は false を返します。これにより、書き込みが正常に行われたかどうかを判断できます。
使用例
基本的な使い方
<?php
$fp = fopen("example.txt", "w");
fwrite($fp, "こんにちは、世界!");
fclose($fp);
?>
ファイルを「書き込みモード(w)」で開き、「こんにちは、世界!」という文字列を書き込みます。書き込み後は必ず fclose でファイルを閉じましょう。
ファイルに追記する例
<?php
$fp = fopen("log.txt", "a");
fwrite($fp, "新しいログ行n");
fclose($fp);
?>
「追記モード(a)」でファイルを開き、既存の内容の末尾に「新しいログ行」を追加しています。
一部だけ書き込む例
<?php
$fp = fopen("data.txt", "w");
fwrite($fp, "ABCDEFGH", 4);
fclose($fp);
?>
文字列「ABCDEFGH」のうち先頭から4バイト(”ABCD”)だけを書き込みます。$length パラメータを利用した例です。
関連する関数
fopen— ファイルを開くfclose— ファイルを閉じるfile_put_contents— ファイルに文字列を書き込む(簡単な用途向け)fread— ファイルから読み込む
まとめ
fwrite はPHPでファイルに文字列を書き込むための基本的かつ重要な関数です。効率的にファイル操作を行うためには、適切なファイルポインタの取得や閉じる処理と組み合わせて使う必要があります。複数文字列の部分書き込みや追記など、さまざまな用途に対応できるため、実務でも広く利用されています。
