古いセッションを削除する

# SessionHandler::gc

(PHP 5 >= 5.4.0, PHP 7, PHP 8)

SessionHandler::gc — 古いセッションを削除する

### 説明

public function SessionHandler::gc(int `$max_lifetime`): int|false

有効期限を過ぎたセッションを削除します。PHP がセッションを開始したとき、あるいは session_start() を実行したときにコールされます。 コールされる頻度は、session.gc_divisor および session.gc_probability の設定に基づいて決まります。

このメソッドは、このハンドラが session_set_save_handler() で設定される前に ini 設定 session.save_handler で定義されていた PHP の保存ハンドラをラップします。

このクラスを継承して拡張する場合は、親の `gc` メソッドをコールすればこのメソッドのラッパーを実行でき、それに付随する内部コールバックも実行されます。 こうすれば、メソッドをオーバーライドしたり処理を横取りしてフィルタを追加したりできます。

このメソッドに関する詳細は、 SessionHandlerInterface::gc() のドキュメントを参照ください。

### パラメータ

`max_lifetime`

  直近の `max_lifetime` 秒の間に更新されていないセッションを削除します。

### 戻り値

成功時には、削除されたセッションの数を返します。 失敗した場合に `false` を返します。 この値は、処理を続けるために PHP の内部にも返される点に注意して下さい。

### 変更履歴

バージョン | 説明
--- | ---
7.1.0 | これより前のバージョンでは、この関数は成功時に `true` を返していました。

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open