Function __global->get_session_id

Definitions

sources/users.php

  • Get the current session ID.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$ignore_static_cache boolean No No False N/A N/A Whether to ignore the fact there may be a static cache; used to get true session ID during authentication code to break a paradoxs
$ignore_ip_validation boolean No No False N/A N/A Whether to ignore IP validation when getting the session; always ignored if the IP address is the server

Returns

  • The current session ID (blank: none)
  • Type: ID_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the current session ID.
 *
 * @param  boolean $ignore_static_cache Whether to ignore the fact there may be a static cache; used to get true session ID during authentication code to break a paradoxs
 * @param  boolean $ignore_ip_validation Whether to ignore IP validation when getting the session; always ignored if the IP address is the server
 * @return ID_TEXT The current session ID (blank: none)
 */
function get_session_id(bool $ignore_static_cache = false, bool $ignore_ip_validation = false) : string