PHP Conference Japan 2024

SessionHandler::gc

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

SessionHandler::gc清理旧会话

描述

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

清理过期的会话。当会话启动或调用 session_start() 时,PHP 内部会随机调用此方法。调用频率基于 session.gc_divisorsession.gc_probability 配置指令。

此方法包装了在设置此处理程序之前由 session_set_save_handler() 设置的 session.save_handler ini 设置中定义的 PHP 内部保存处理程序。

如果此类通过继承进行扩展,则调用父级 gc 方法将调用此方法的包装器,从而调用相关的内部回调。这允许覆盖或拦截和过滤此方法。

有关此方法预期执行的操作的更多信息,请参阅 SessionHandlerInterface::gc() 中的文档。

参数

max_lifetime

过去 max_lifetime 秒内未更新的会话将被删除。

返回值

成功时返回已删除的会话数,失败时返回 false。请注意,此值会内部返回给 PHP 以进行处理。

变更日志

版本 描述
7.1.0 在此版本之前,该函数在成功时返回 true
添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top