PHP 8.4.2 Released!

session_gc

(PHP 7 >= 7.1.0, PHP 8)

session_gcExécute le ramasse miette des données de session

Description

session_gc(): int|false

session_gc() est utilisé pour exécuter le ramasse miette (Garbage Collection abrégée GC). PHP utilise une méthode probabiliste pour exécuter le ramasse miette de session par défaut.

Le ramassage de miette (GC) basé sur une méthode probabiliste fonctionne quelque peu mais a quelques problèmes. 1) Les données de session des sites à faible traffic ne seront peut être pas supprimés durant la durée préféré. 2) Les sites à fort traffic exécuteront potentiellement le ramasse miette à une trop grande fréquence. 3) Le ramasse miette est exécuté sur une requête utilisateur et celui-ci ressentira une latence due au ramasse miette.

Par conséquent, il est recommandé d'exécuter le ramasse miette périodiquement sur les systèmes de productions, par exemple, "cron" pour les systèmes de type UNIX. Assurez-vous de désactiver le ramasse miette à méthode probabiliste en définissant session.gc_probability à 0.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

session_gc() retourne le nombre de données de session effacé en tant que succès, false en cas d'échec.

Les anciens gestionnaire de sauvegarde ne retourne pas le nombre de données de session effacé mais seulement le drapeau de succès/échec. Dans ce cas là, le nombre de données de session effacé est 1 quelque soit le nombre actuel de données effacé.

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

add a note

User Contributed Notes 2 notes

up
0
i dot carvallo at gmail dot com
14 days ago
Do not use:

if (session_gc() == false)
OR
if (!session_gc())

to evaluate if the garbage collector was triggered successfully since it also returns how many sessions it deleted, which can be 0 (and that evaluates to false with loose operators).

Sounds dumb, but it's a pitfall i fell into and it generated some confusion. Instead, use strict operator "===":

if (session_gc() === false)
up
0
ridaelkouri at gmail dot com
1 month ago
The session.gc() function does not seem to work alone. it deletes the data on the server but the data remains on the browser in the form of the cookie. the following code deletes the session files on the server but not on the browser.

ini_set('session.gc_maxlifetime', 10);
ini_set('session.gc_probability', 1);
ini_set('session.gc_divisor', 1);

// Start the session
session_start();
$_SESSION['test'] = 'temporary data';

session_write_close();

// Wait for 15 seconds to ensure the session expires
sleep(15);

// Manually start the session again to trigger session handling
session_start();

session_gc();

// Check if the session data is still available
if (isset($_SESSION['test'])) {
echo "Session is still active.";
} else {
echo "Session expired and file deleted.";
}

but this code delete the session files on the server and also deletes the cookie as well as making the super global empty:

session_start();
$_SESSION['test'] = 'temporary data';

session_write_close();

// Wait for 15 seconds to ensure the session expires
sleep(15);

session_start();

// Manually trigger garbage collection
setcookie(session_name(), '', time() - 10);
$_SESSION = [];
session_gc();

// Check if the session data is still available
if (isset($_SESSION['test'])) {
echo "Session is still active.";
} else {
echo "Session expired and file deleted.";
}
To Top