array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.session-cache-expire.php', 1 => 'session_cache_expire', 2 => 'Get and/or set current cache expire', ), 'up' => array ( 0 => 'ref.session.php', 1 => 'Session Functions', ), 'prev' => array ( 0 => 'function.session-abort.php', 1 => 'session_abort', ), 'next' => array ( 0 => 'function.session-cache-limiter.php', 1 => 'session_cache_limiter', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/session/functions/session-cache-expire.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

session_cache_expire

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

session_cache_expire — Get and/or set current cache expire

Description

session_cache_expire(?int $value = null): int|false

session_cache_expire() returns the current setting of session.cache_expire.

The cache expire is reset to the default value of 180 stored in session.cache_expire at request startup time. Thus, you need to call session_cache_expire() for every request (and before session_start() is called).

Parameters

value

If value is given and not null, the current cache expire is replaced with value.

Note: Setting value is of value only, if session.cache_limiter is set to a value different from nocache.

Return Values

Returns the current setting of session.cache_expire. The value returned should be read in minutes, defaults to 180. On failure to change the value, false is returned.

Changelog

Version Description
8.0.0 value is nullable now.

Examples

Example #1 session_cache_expire() example

<?php

/* set the cache limiter to 'private' */

session_cache_limiter('private');
$cache_limiter = session_cache_limiter();

/* set the cache expire to 30 minutes */
session_cache_expire(30);
$cache_expire = session_cache_expire();

/* start the session */

session_start();

echo "The cache limiter is now set to $cache_limiter<br />";
echo "The cached session pages expire after $cache_expire minutes";
?>

See Also