- * @param bool $need_sid Specify if the session id is needed or not. Default is false.

- * @param bool $update_session_page If true the session page gets updated. This can be set to false to circumvent certain scripts to update the users last visited page.

- * @return bool True if the session exist or has been created, else False.

- * @param int $user_id The user id to create the session for.

- * @param bool $set_admin Set the users admin field to identify him/her as an admin?

- * @param bool $persist_login Allow persistent login

- * @param bool $viewonline If false then the user will be logged in as hidden

- * @return bool True if session got created successfully.

- * @param bool $new_session If true a new session will be generated after the original one got killed.

- * @param string $name Name of the cookie, will be automatically prefixed with the phpBB cookie name. track becomes [cookie_name]_track then.

- * @param string $cookiedata The data to hold within the cookie

- * @param int $cookietime The expiration time as UNIX timestamp. If 0 is provided, a session cookie is set.

- * @param int $user_id The user id to check. If false then do not check user ids

- * @param string|array $user_ips Can contain a string with one IP or an array of multiple IPs. If false then no ips are checked.

- * @param int $user_email The email address to check

- * @param bool $return If false then the banned message is displayed and script halted

- * @return bool|string True if banned and no reason given. False if not banned. A ban reason if banned and ban reason given. Check for !== false.

- * @param string $mode register/post - spamcop for example is ommitted for posting

- * @param string $ip The ip to check. If false then the current IP is used

- * @return bool|array false if ip is not blacklisted, else an array([checked server], [lookup])

- * @param int $user_id The user id. If false the current users user id will be used

- * @param string $key A login key. If false then the current users login key stored within the cookie will be used

- * @param string $user_ip The users ip. If false, then the current users IP will be used

- * @param int $user_id The user id. If false then the current users user id is used.

- * @return bool true if a valid, non-expired session exist

- * @param bool $check_script_path If true, the path will be checked as well

- * @return bool True if the referer is valid

- * @return array default user data array

- * @return bool True if it is a bot.

- * @param bool $log_failure If true then a non-match will be logged. Can cause huge logs.

- * @return bool true if the session is valid

- * @param string $auth_method The authentication method to use, for example 'db'

- * @param string $custom_lang_path An optional language pack path.

- * @param bool $update_session_page If true the session page gets updated. This can be set to false to circumvent certain scripts to update the users last visited page.

- * @param string $lang_path New language path used.

- * @param string|array $lang_set Language set to setup. Can be a string or an array of language files without a path and extension. Format must match {@link add_lang() add_lang}.

- * @param int $style If not set to false this specifies the style id to use. The page will then use the specified style id instead of the default one.

- * @param string $key The language key to use

- * @param mixed $parameter,... An unlimited number of parameter to apply.

- * @return string Substituted language string

- * @param mixed $lang_set specifies the language entries to include

- * @param bool $use_db internal variable for recursion, do not use

- * @param bool $use_help internal variable for recursion, do not use

- * @param array &$lang A reference to the language array phpbb::$user->lang

- * @param array &$help A reference to the language help array phpbb::$user->help

- * @param string $lang_file Language filename

- * @param bool $use_db True if the database is used for obtaining the information

- * @param bool $use_help True if we fetch help entries instead of language entries

- * @param int $gmepoch unix timestamp to format

- * @param string $format date format in date() notation. | used to indicate relative dates, for example |d m Y|, h:i is translated to Today, h:i.

- * @param bool $forcedate force non-relative date format.

- * @staticvar int $midnight Midnight time offset

- * @staticvar array $date_cache array to cache commonly needed structures within this function

- * @param int $user_id user id. If not specified the current users profile fields are grabbed.

- * @return array profile fields. If the current user then they are also stored as property $profile_fields.

- * @param string $img the imageset image key name

- * @param string $alt an optional alternative image attribute. If a corresponding language key exist it will be used: phpbb::$user->lang[$alt]

- * @param string $type the preferred type to return. Allowed types are: full_tag, src, width, height

- * @param int $width set image width

- * @return mixed returns the preferred type from $type

- * @param string $key the option key from {@link $keyoptions keyoptions}

- * @param int $data optional user options bitfield. If not specified then {@link $data $data['user_options']} is used.

- * @return bool corresponding option value returned. Is the option enabled or disabled.

- * @param string $key the option key from {@link $keyoptions keyoptions}

- * @param bool $value true to enable the option, false to disable it

- * @param int $data optional user options bitfield. If not specified then {@link $data $data['user_options']} is used.

- * @return bool the new user options bitfield is returned if $data is specified, else: false is returned if user options not changed, true if changed.

- * @param string $username the specified user name

- * @param string $password the specified password

- * @param bool $autologin enable/disable persistent login

- * @param bool $viewonline If false then the user will be logged in as hidden

- * @param bool $admin If true the user requests an admin login

- * @return array login result array. This array returns results to the login script to show errors, notices, confirmations.