session_gc

(PHP 7 >= 7.1.0, PHP 8)

session_gc — Exécute le ramasse miette des données de session

Description

session_gc(): int|false

Par défaut, PHP utilise session.gc_probability pour exécuter le ramasse miette des sessions de façon probabiliste à chaque requête. Il y a certaines limitations avec cette approche :

  • Les sites à faible trafic peuvent ne pas avoir leurs données de session supprimées dans la durée préférée.
  • Les sites à fort trafic peuvent voir le ramasse-miette s'exécuter trop fréquemment, effectuant un travail supplémentaire inutile.
  • Le ramasse-miette est effectué lors de la requête de l'utilisateur, et l'utilisateur peut subir un délai.

Pour les systèmes de production, il est recommandé de désactiver le ramasse-miette basé sur la probabilité en configurant session.gc_probability à 0 et explicitement exécuter le ramasse-miette périodiquement, par exemple en utilisant "cron" sur les systèmes de type UNIX pour exécuter un script qui appelle session_gc().

Note: Lors de l'appel de session_gc() depuis un script PHP en ligne de commande, le session.save_path doit être défini à la même valeur que pour les requêtes web, et le script doit avoir les permissions d'accès et de suppression pour les fichiers de session. Cela peut être affecté par l'utilisateur sous lequel le script s'exécute, ainsi que par des fonctionnalités de conteneur ou de sandboxing telles que l'option PrivateTmp= option.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

session_gc() renvoie le nombre d'entrées de sessions supprimées en cas de succès, ou false si une erreur survient.

Note: Les vieux gestionnaires de sauvegarde de session ne renvoient pas le nombre d'entrées de session supprimées, mais plutôt seulement un indicateur de succès/échec. Si c'est le cas, 1 est renvoyé indépendamment du nombre d'entrées de session réellement supprimées.

Exemples

Exemple #1 Exemple de session_gc() pour les planificateurs de tâches comme cron

<?php
// Note: Ce script devrait être exécuté par le même utilisateur que le processus du serveur web.

// Nécessite l'activation des sessions pour initialiser l'accès au gestionnaire de sauvegarde des sessions
session_start();

// Exécuter le Ramasse Miette immédiatement
session_gc();

// Effacer l'ID de session créé par session_gc()
session_destroy();
?>

Exemple #2 Exemple de session_gc() pour des scripts accessible par l'utilisateur

<?php
// Note: il est recommandé que session_gc() soit utilisé par un planificateur de tâches,
// mais il peut être utilisé de la façon suivante.

// Utilisé pour vérifier l'heure de la dernière utilisation du ramasse miette
$gc_time = '/tmp/php_session_last_gc';
$gc_period = 1800;

session_start();
// Exécuter le ramasse miette seulement quand la période s'est écoulée.
// Appeler session_gc() à chaque requête est un gaspillage de ressource.
if (file_exists($gc_time)) {
if (filemtime($gc_time) < time() - $gc_period) {
session_gc();
touch($gc_time);
}
} else {
touch($gc_time);
}
?>

Voir aussi

↑↓ • • •