【PHP8.x】fwrite関数の使い方
作成日: 更新日:
fwrite関数は、ファイルポインタへの文字列データ書き込みを実行する関数です。この関数は、fopen()
関数などで開かれたファイルリソースに指定された文字列を書き込みます。
第一引数にfopen()
から返されるファイルポインタを、第二引数に書き込む文字列データを指定します。オプションの第三引数で書き込む最大バイト数を整数値で指定でき、これを省略した場合は文字列全体がファイルに書き込まれます。
関数は、実際にファイルに書き込まれたバイト数を整数値で返します。書き込みに失敗した場合はfalse
が返されます。ディスク容量不足やファイルへの書き込み権限不足などが失敗原因として挙げられます。
fwrite()
関数はバイナリセーフであり、どのような内容の文字列でもそのまま書き込めます。また、fputs()
関数のエイリアス(別名)でもあります。ログ生成、設定ファイルの更新、データの永続化といったファイル操作で広く利用されます。
基本的な使い方
構文(syntax)
<?php
$fileHandle = fopen('output.txt', 'w');
if ($fileHandle !== false) {
$dataToWrite = 'Hello from PHP fwrite!';
$bytesWritten = fwrite($fileHandle, $dataToWrite);
fclose($fileHandle);
}
?>
引数(parameters)
resource $stream, string $data, ?int $length = null
PHP:
- resource $stream: 書き込み対象のファイルポインタ(リソース型)
- string $data: 書き込むデータ(文字列)
- ?int $length = null: 書き込むデータのバイト数(省略可能、指定しない場合は $data 全体を書き込む)
戻り値(return)
int|false
書き込まれたバイト数を返します。エラーが発生した場合は false を返します。