Function Hook_login_provider_httpauth->try_login

Definitions

sources/hooks/systems/login_providers/httpauth.php

  • Standard login provider hook.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_id ?MEMBER No No required parameter N/A N/A Member ID already detected as logged in (null: none). May be a guest ID.
$quick_only boolean No No False N/A N/A Whether to just do a quick check, don't establish new sessions

Returns

  • Member ID now detected as logged in (null: none). May be a guest ID.
  • Type: ?MEMBER
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Standard login provider hook.
 *
 * @param  ?MEMBER $member_id Member ID already detected as logged in (null: none). May be a guest ID.
 * @param  boolean $quick_only Whether to just do a quick check, don't establish new sessions
 * @return ?MEMBER Member ID now detected as logged in (null: none). May be a guest ID.
 */
public function try_login(?int $member_id, bool $quick_only = false) : ?int