add_form_key (line 2244)

Add a secret token to the form (requires the S_FORM_TOKEN template variable)

• string $form_name: The name of the form; has to match the name used in check_form_key, otherwise no restrictions apply

append_sid (line 1809)

Append session id to url.

This function supports hooks.

• string $url: The url the session id needs to be appended to (can have params)
• mixed $params: String or array of additional url parameters
• bool $is_amp: Is url using & (true) or & (false)
• string $session_id:

  Possibility to use a custom session id instead of the global one

  Examples:

  1.  append_sid("{$phpbb_root_path}viewtopic.$phpEx?t=1&f=2");
  2.  append_sid("{$phpbb_root_path}viewtopic.$phpEx", 't=1&f=2');
  3.  append_sid("{$phpbb_root_path}viewtopic.$phpEx", 't=1&f=2', false);
  4.  append_sid("{$phpbb_root_path}viewtopic.$phpEx", array('t' => 1, 'f' => 2));

build_hidden_fields (line 2765)

Build simple hidden fields from array

• return: the hidden fields

• array $field_ary: an array of values to build the hidden field from
• bool $specialchar: if true, keys and values get specialchared
• bool $stripslashes: if true, keys and values get stripslashed

check_form_key (line 2267)

Check the form key. Required for all altering actions not secured by confirm_box

• string $form_name: The name of the form; has to match the name used in add_form_key, otherwise no restrictions apply
• int $timespan: The maximum acceptable age for a submitted form in seconds. Defaults to the config setting.
• string $return_page: The address for the return link
• bool $trigger: If true, the function will triger an error when encountering an invalid form

confirm_box (line 2315)

Build Confirm box

• boolean $check: True for checking if confirmed (without any additional parameters) and false for displaying the confirm box
• string $title: Title/Message used for confirm box. message text is _CONFIRM appended to title. If title cannot be found in user->lang a default one is displayed If title_CONFIRM cannot be found in user->lang the text given is used.
• string $hidden: Hidden variables
• string $html_body: Template used for confirm box
• string $u_action: Custom form action

garbage_collection (line 3821)

Closing the cache object and the database

Cool function name, eh? We might want to add operations to it later

generate_link_hash (line 2218)

Add a secret hash for use in links/GET requests

• return: the hash

• string $link_name: The name of the link; has to match the name used in check_link_hash, otherwise no restrictions apply

gen_rand_string (line 170)

Generates an alphanumeric random string of given length

• $num_chars

get_complete_topic_tracking (line 1330)

Get topic tracking info from db (for cookie based tracking only this function is used)

• $forum_id
• $topic_ids
• $global_announce_list

get_preg_expression (line 2952)

This function returns a regular expression pattern for commonly used expressions

Use with / as delimiter for email mode and # for url modes mode can be: email|bbcode_htm|url|url_inline|www_url|www_url_inline|relative_url|relative_url_inline|ipv4|ipv6

• $mode

is_absolute (line 693)

Checks if a path ($path) is absolute or relative

• string $path: Path to check absoluteness of

login_box (line 2418)

Generate login box or verify password

• $redirect
• $l_explain
• $l_success
• $admin
• $s_display

markread (line 991)

Marks a topic/forum as read Marks a topic as posted to

• int $user_id: can only be used with $mode == 'post'
• $mode
• $forum_id
• $topic_id
• $post_time

msg_handler (line 3096)

Error and message handler, call with trigger_error if reqd

• $errno
• $msg_text
• $errfile
• $errline

obtain_users_online (line 3343)

Queries the session table to get information about online users

• return: An array containing the ids of online, hidden and visible users, as well as statistical info

• int $forum_id: Limits the search to the forum with this id

on_page (line 1773)

Return current page (pagination)

• $num_items
• $per_page
• $start

page_header (line 3514)

Generate page header

• $page_title
• $display_online_list

phpbb_checkdnsrr (line 3046)

Wrapper for php's checkdnsrr function.

The windows failover is from the php manual Please make sure to check the return value for === true and === false, since NULL could be returned too.

• return: if entry found, false if not, NULL if this function is not supported by this environment

• $host
• $type

phpbb_chmod (line 484)

Global function for chmodding directories and files for internal use This function determines owner and group whom the file belongs to and user and group of PHP and then set safest possible file permissions.

The function determines owner and group from common.php file and sets the same to the provided file. The function uses bit fields to build the permissions. The function sets the appropiate execute bit on directories.

Supported constants representing bit fields are:

CHMOD_ALL - all permissions (7) CHMOD_READ - read permission (4) CHMOD_WRITE - write permission (2) CHMOD_EXECUTE - execute permission (1)

NOTE: The function uses POSIX extension and fileowner()/filegroup() functions. If any of them is disabled, this function tries to build proper permissions, by calling is_readable() and is_writable() functions.

• return: on success, otherwise false
• author: faw, phpBB Group

• $filename $filename: The file/directory to be chmodded
• $perms $perms: Permissions to set

phpbb_own_realpath (line 704)

• author: Chris Smith <chris@project-minerva.org>
• copyright: 2006 Project Minerva Team

• string $path: The path which we should attempt to resolve.

phpbb_user_session_handler (line 3866)

Handler for init calls in phpBB. This function is called in user::setup(); This function supports hooks.

redirect (line 1952)

Redirects the user to another page then exits the script nicely This function is intended for urls within the board. It's not meant to redirect to cross-domains.

• string $url: The url to redirect to
• bool $return: If true, do not redirect but return the sanitized URL. Default is no return.
• bool $disable_cd_check: If true, redirect() will redirect to an external domain. If false, the redirect point to the boards url if it does not match the current domain. Default is false.

set_config (line 141)

Set config value. Creates missing config entry.

• $config_name
• $config_value
• $is_dynamic

short_ipv6 (line 3012)

Returns the first block of the specified IPv6 address and as many additional ones as specified in the length paramater.

If length is zero, then an empty string is returned. If length is greater than 3 the complete IP will be returned

• $ip
• $length

stripos (line 676)

A wrapper for the PHP5 function stripos Find position of first occurrence of a case-insensitive string

• return: Returns the numeric position of the first occurrence of needle in the haystack string. Unlike strpos(), stripos() is case-insensitive. Note that the needle may be a string of one or more characters. If needle is not found, stripos() will return boolean FALSE.

• string $haystack: is the string to search in
• string $needle: is the string to search for

style_select (line 932)

Pick a template/theme combo,

• $default
• $all

tracking_unserialize (line 1586)

Transform a serialized array into an actual array

• $string
• $max_depth

unique_id (line 182)

Return unique id

• string $extra: additional entropy

_build_hidden_fields (line 2731)

Little helper for the build_hidden_fields function

• $key
• $value
• $specialchar
• $stripslashes

_hash_encode64 (line 360)

Encode hash

• $input
• $count
• &$itoa64