Function __global->get_brand_session

Definitions

sources/telemetry.php

  • Establish a guest session ID with the homesite and return it.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$get_hashed boolean No No True N/A N/A Whether to get the hashed session ID instead of the actual one

Returns

  • The session ID (null: error)
  • Type: ?ID_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Establish a guest session ID with the homesite and return it.
 *
 * @param  boolean $get_hashed Whether to get the hashed session ID instead of the actual one
 * @return ?ID_TEXT The session ID (null: error)
 */
function get_brand_session(bool $get_hashed = true) : ?string