SessionHandler::gc

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

SessionHandler::gc — Nettoie les anciennes sessions

Description

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

Nettoie les sessions expirées. Appelé aléatoirement en interne par PHP lorsqu'une session démarre ou lorsque la fonction session_start() est appelée. La fréquence d'appel est basée sur les directives de configuration session.gc_divisor et session.gc_probability.

Cette méthode se substitue au gestionnaire interne de sauvegarde PHP défini via l'option de configuration session.save_handler qui a été définie avant que ce dernier ne le soit via la fonction session_set_save_handler().

Si cette classe est étendue par héritage, l'appel à la méthode parente gc invoquera l'enveloppe pour cette méthode, mais aussi, invoquera en interne la fonction de rappel associée. Ce comportement permet à cette méthode d'être surchargée ou bien d'être interceptée et filtrée.

Pour plus d'informations sur l'attendu de cette méthode, se référer à la documentation sur la fonction SessionHandlerInterface::gc().

Liste de paramètres

max_lifetime: Les sessions qui n'auront pas été mises à jour les dernières max_lifetime secondes seront supprimées.

Valeurs de retour

Retourne le nombre de sessions supprimées en cas de succès, ou false si une erreur survient. Il est à noter que cette valeur est retournée en interne à PHP pour traitement.

Historique

Version	Description
7.1.0	Antérieur à cette version, cette fonction retournait `true` en cas de succès.