Function __global->save_user_metadata

Definitions

sources/lookup.php

  • Save analytics metadata for the current user's request into a file.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$include_referer boolean No No False N/A N/A Whether to include the referer
$member_id ?MEMBER No No Null N/A N/A Member to lookup (null: current user)
$ip ?IP No No Null N/A N/A IP address (null: current / member's)

Returns

  • The path of the file
  • Type: PATH
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Save analytics metadata for the current user's request into a file.
 *
 * @param  boolean $include_referer Whether to include the referer
 * @param  ?MEMBER $member_id Member to lookup (null: current user)
 * @param  ?IP $ip IP address (null: current / member's)
 * @return PATH The path of the file
 */
function save_user_metadata(bool $include_referer = false, ?int $member_id = null, ?string $ip = null) : string