PHP session_set_cookie_params 会话函数



  • 定义和用法

    session_set_cookie_params - 设置会话 cookie 参数
  • 版本支持

    PHP4 PHP5 PHP7
    支持 支持 支持
    7.3.0 增加 options 参数, 可以通过传入一个关联数组对各个选项进行设置。 同时,通过使用这个参数还可以对 SameSite cookie 进行设置。
    7.2.0 成功时返回 TRUE, 或者在失败时返回 FALSE。 之前版本中是返回 void 的。
    5.2.0 加入 httponly 参数。
  • 语法

    session_set_cookie_params ( int $lifetime [, string $path [, string $domain [, bool $secure = FALSE [, bool $httponly = FALSE ]]]]  )
    
    或者:
    session_set_cookie_params ( array $options ) 
    
    Cookie 参数可以在 php.ini 文件中定义,本函数仅在当前脚本执行过程中有效。 因此,如果要通过函数修改 cookie 参数,需要对每个请求都要 在调用 session_start() 函数之前调用 session_set_cookie_params() 函数。 本函数会修改运行期 ini 设置值, 可以通过 ini_get() 函数获取这些值。
  • 参数

    参数 必需的 描述
    lifetime Cookie 的 生命周期,以秒为单位。
    path 此 cookie 的有效 路径。 on the domain where 设置为“/”表示对于本域上所有的路径此 cookie 都可用。
    domain Cookie 的作用 域。 例如:“www.php.net”。 如果要让 cookie 在所有的子域中都可用,此参数必须以点(.)开头,例如:“.jc2182.net”。
    secure 设置为 TRUE 表示 cookie 仅在使用 安全 链接时可用。
    httponly 设置为 TRUE 表示 PHP 发送 cookie 的时候会使用 httponly 标记。
    options 此参数为一个键值对关联 array,可能包含的键有: lifetime,path,domain, secure,httponly 以及 samesite。 这些键对应的值和上面所述的一样。 samesite 键对应的值可以是 Lax 或者 Strict。 如果可以接受的键在传入的数组中不存在, 那么会采用这些键对应的默认值作为运行时的值。 如果不提供 samesite 键, 那么就设置 SameSite cookie 属性。
  • 返回值

    成功时返回 TRUE, 或者在失败时返回 FALSE。
  • 相关函数

    session_get_cookie_params() - 获取会话 cookie 参数