<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.session.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.session-gc.php',
    1 => 'session_gc',
    2 => 'Ejecuta la recolecci&oacute;n de basura de los datos de sesi&oacute;n',
  ),
  'up' => 
  array (
    0 => 'ref.session.php',
    1 => 'Funciones de sesi&oacute;n',
  ),
  'prev' => 
  array (
    0 => 'function.session-encode.php',
    1 => 'session_encode',
  ),
  'next' => 
  array (
    0 => 'function.session-get-cookie-params.php',
    1 => 'session_get_cookie_params',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/session/functions/session-gc.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.session-gc" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">session_gc</h1>
  <p class="verinfo">(PHP 7 &gt;= 7.1.0, PHP 8)</p><p class="refpurpose"><span class="refname">session_gc</span> &mdash; <span class="dc-title">Ejecuta la recolección de basura de los datos de sesión</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.session-gc-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>session_gc</strong></span>(): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Por omisión, PHP utiliza <a href="session.configuration.php#ini.session.gc-probability" class="link">session.gc_probability</a>
   para ejecutar el recolector de basura de sesión de forma probabilística en cada
   solicitud. Este enfoque presenta algunas limitaciones:
  </p>
  <ul class="simplelist">
   <li>Es posible que sitios con poco tráfico no eliminen sus datos de sesión dentro del plazo preferido.</li>
   <li>Sitios con mucho tráfico pueden hacer que el recolector de basura funcione con demasiada frecuencia, realizando trabajo extra innecesario.</li>
   <li>La recolección de basura se realiza a petición del usuario, y este puede experimentar una demora.</li>
  </ul>
  <p class="simpara">
   Para sistemas de producción, se recomienda deshabilitar la
   recolección de basura basada en probabilidad configurando
   <a href="session.configuration.php#ini.session.gc-probability" class="link">session.gc_probability</a> en <code class="literal">0</code>
   y activar explícitamente el recolector de basura periódicamente, por ejemplo, utilizando &quot;cron&quot; en
   sistemas tipo UNIX para ejecutar un script que llame a <span class="function"><strong>session_gc()</strong></span>.
  </p>

  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <span class="simpara">
    Al llamar a <span class="function"><strong>session_gc()</strong></span> desde un script PHP de línea de comandos,
    <a href="session.configuration.php#ini.session.save-path" class="link">session.save_path</a> debe tener
    el mismo valor que las solicitudes web, y el script debe tener permisos de acceso y eliminación
    para los archivos de sesión. Esto puede verse afectado por el usuario con el que se ejecuta el script
    y por características de contenedor o aislamiento, como la opción <code class="literal">PrivateTmp=</code>
    de systemd.
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.session-gc-parameters">
  <h3 class="title">Parámetros</h3>
  <p class="para">Esta función no contiene ningún parámetro.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.session-gc-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="simpara">
   <span class="function"><strong>session_gc()</strong></span> devuelve el número de datos de sesión eliminados
   en caso de éxito,  o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si ocurre un error.
  </p>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <span class="simpara">
    Los antiguos gestores de almacenamiento de sesiones no devuelven el número de entradas de sesión eliminadas, sino
    solo un indicador de éxito/fracaso. En este caso, se devuelve <code class="literal">1</code> independientemente de
    cuántas entradas de sesión se hayan eliminado realmente.
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 examples" id="refsect1-function.session-gc-examples">
  <h3 class="title">Ejemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Ejemplo #1 Ejemplo de <span class="function"><strong>session_gc()</strong></span> para planificadores de tareas como cron</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// Nota: Este script debe ser ejecutado por el mismo usuario que el proceso del servidor web.<br /><br />// Requiere la activación de las sesiones para inicializar el acceso al gestor de almacenamiento de sesiones<br /></span><span style="color: #0000BB">session_start</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Ejecutar la recolección de basura inmediatamente<br /></span><span style="color: #0000BB">session_gc</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Eliminar el ID de sesión creado por session_start()<br /></span><span style="color: #0000BB">session_destroy</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>Ejemplo #2 Ejemplo de <span class="function"><strong>session_gc()</strong></span> para scripts accesibles por el usuario</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// Nota: Se recomienda que session_gc() sea utilizado por un planificador de tareas,<br />// pero puede ser utilizado de la siguiente manera.<br /><br />// Utilizado para verificar la hora del último uso de la recolección de basura<br /></span><span style="color: #0000BB">$gc_time </span><span style="color: #007700">= </span><span style="color: #DD0000">'/tmp/php_session_last_gc'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$gc_period </span><span style="color: #007700">= </span><span style="color: #0000BB">1800</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">session_start</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">// Ejecutar la recolección de basura solo cuando haya transcurrido el período.<br />// Es decir, llamar a session_gc() en cada solicitud es un desperdicio de recursos.<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">file_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$gc_time</span><span style="color: #007700">)) {<br />    if (</span><span style="color: #0000BB">filemtime</span><span style="color: #007700">(</span><span style="color: #0000BB">$gc_time</span><span style="color: #007700">) &lt; </span><span style="color: #0000BB">time</span><span style="color: #007700">() - </span><span style="color: #0000BB">$gc_period</span><span style="color: #007700">) {<br />        </span><span style="color: #0000BB">session_gc</span><span style="color: #007700">();<br />        </span><span style="color: #0000BB">touch</span><span style="color: #007700">(</span><span style="color: #0000BB">$gc_time</span><span style="color: #007700">);<br />    }<br />} else {<br />    </span><span style="color: #0000BB">touch</span><span style="color: #007700">(</span><span style="color: #0000BB">$gc_time</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.session-gc-seealso">
  <h3 class="title">Ver también</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.session-start.php" class="function" rel="rdfs-seeAlso">session_start()</a> - Inicia una nueva sesi&oacute;n o reanuda una sesi&oacute;n existente</span></li>
   <li><span class="function"><a href="function.session-destroy.php" class="function" rel="rdfs-seeAlso">session_destroy()</a> - Destruye una sesi&oacute;n</span></li>
   <li><a href="session.configuration.php#ini.session.gc-probability" class="link">session.gc_probability</a></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>