PHPのflock()関数とは？ファイルロックの基本と使い方を解説

PHPのflock()関数は、開いているファイルに対してロック（施錠）または解除（解放）を行うための関数です。複数のスクリプトが同時に同じファイルへアクセスする際に、データの破損や競合を防ぐために利用されます。この関数は処理が成功するとTRUEを返し、失敗するとFALSEを返します。

構文

flock(file_pointer, operation, block)

パラメータ

• file_pointer − ロックまたは解除の対象となる、fopen()などで開いたファイルへのポインタ（リソース）です。

• operation − 使用するロックの種類を指定します。指定できる定数は以下の通りです。

  • LOCK_SH − 共有ロック（読み取り用）。複数のプロセスが同時に読み取ることを許可します。
  • LOCK_EX − 排他ロック（書き込み用）。他のプロセスからのアクセスを完全にブロックします。
  • LOCK_UN − 共有ロックおよび排他ロックを解除します。

• block − ロック取得時に処理をブロック（待機）させたい場合は1を設定します。省略時や0の場合はノンブロッキング動作となり、ロックできない場合は即座にFALSEが返されます。

戻り値

flock()関数は以下の値を返します。

• 成功した場合は TRUE
• 失敗した場合は FALSE

使用例

次の例では、new.txtというファイルを開き、共有ロックを取得してから内容を書き込み、その後にロックを解放しています。

<?php
   $file_pointer = fopen("new.txt","w+");
   // 共有ロックを取得
   if (flock($file_pointer,LOCK_SH)) {
      fwrite($file_pointer,"Some content");
      // ロックを解放
      flock($file_pointer,LOCK_UN);
   } else {
      echo "ファイルのロックでエラーが発生しました！";
   }
   fclose($file_pointer);
?>

出力

TRUE

補足ポイント

flock()を使用する際には、いくつか注意点があります。

• NFSなどの一部のネットワークファイルシステムでは、flock()が正しく機能しない場合があります。
• ロックを適切に解放しないと、他のプロセスが待ち続ける原因になるため、処理後は必ずLOCK_UNで解除しましょう。
• fclose()を呼び出すとロックも自動的に解放されますが、明示的にLOCK_UNを呼ぶことが推奨されています。