session_get_cookie

Description

array session_get_cookie_params ( void )

The session_get_cookie_params() function returns an array with the current session cookie information, the array contains the following items:

"lifetime" - The lifetime of the cookie in seconds.
"path" - The path where information is stored.
"domain" - The domain of the cookie.
"secure" - The cookie should only be sent over secure connections. (This item was added in PHP 4.0.4.)

See also the configuration directives session.cookie_lifetime, session.cookie_path, session.cookie_domain, session.cookie_secure, and session_set_cookie_params().

add a note User Contributed Notes

scott at firefallpro dot com
01-Dec-2005 06:30


Note that this function pulls the session cookie parameters from the php ini file unless otherwise set with session_set_cookie_params(). In other words it will not check the client cookie's parameters if one exists.

powerlord at spamless dot vgmusic dot com
19-Nov-2002 03:35


This function is quite handy when it comes to expiring session cookies... since Session cookies don't automatically get destroyed (see the session_destroy page).



For instance, here's what I plan to use to expire session cookies:



    $CookieInfo = session_get_cookie_params();

    if ( (empty($CookieInfo['domain'])) && (empty($CookieInfo['secure'])) ) {

        setcookie(session_name(), '', time()-3600, $CookieInfo['path']);

    } elseif (empty($CookieInfo['secure'])) {

        setcookie(session_name(), '', time()-3600, $CookieInfo['path'], $CookieInfo['domain']);

    } else {

        setcookie(session_name(), '', time()-3600, $CookieInfo['path'], $CookieInfo['domain'], $CookieInfo['secure']);

    }

    session_destroy();



It doesn't check to see if the path part of the session cookie is set because the defaults in php.ini have this set already, unlike domain and secure.

add a note