Function __global->try_httpauth_login

Definitions

sources/users_inactive_occasionals.php

  • Try and login via HTTP authentication. This function is only called if HTTP authentication is currently active. With HTTP authentication we trust the PHP_AUTH_USER setting.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$quick_only boolean No No False N/A N/A Whether to just do a quick check, don't establish new sessions

Returns

  • Logged in member (null: no log in happened)
  • Type: ?MEMBER
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Try and login via HTTP authentication. This function is only called if HTTP authentication is currently active. With HTTP authentication we trust the PHP_AUTH_USER setting.
 *
 * @param  boolean $quick_only Whether to just do a quick check, don't establish new sessions
 * @return ?MEMBER Logged in member (null: no log in happened)
 */
function try_httpauth_login(bool $quick_only = false) : ?int