SessionHandler::gc

(PHP 5 >= 5.4.0, PHP 7)

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

説明

public SessionHandler::gc ( int $maxlifetime ) : int

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

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

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

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

パラメータ

maxlifetime

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

返り値

返り値 (通常は、TRUE が成功そして FALSE が失敗を表します)。この値は PHP で内部的に処理されるものであることに注意しましょう。