Function __global->find_user_metadata

Definitions

sources/lookup.php

  • Find analytics metadata for the current user's request.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$include_referer boolean No No True 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)
$advanced boolean No No False N/A N/A Whether to include advanced data

Returns

  • Data
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find analytics metadata for the current user's request.
 *
 * @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)
 * @param  boolean $advanced Whether to include advanced data
 * @return array Data
 */
function find_user_metadata(bool $include_referer = true, ?int $member_id = null, ?string $ip = null, bool $advanced = false) : array