Documentation

SMF

Table of Contents

Interfaces

ActionInterface

Interface for all action classes.

CacheApiInterface

DatabaseApiInterface

Interface DatabaseApiInterface

SearchApiInterface

Interface SearchApiInterface

WebFetchApiInterface

Classes

Activate

Activates a user's account.

ACP

This class, unpredictable as this might be, handles basic administration.

AntiSpam

Handles anti-spam settings.

Attachments

Maintains and manages attachments and avatars.

Bans

This class contains all the methods used for the ban center.

Boards

Manages and maintains the boards and categories of the forum.

Calendar

This class allows you to manage the calendar.

EndSession

Ends an admin session, requiring authentication to access the ACP again.

ErrorLog

Shows a list of all errors that were logged on the forum, and allows filtering and deleting them.

Features

Class to manage various core features.

Find

Provides the search functionality inside the admin control panel.

Home

The administration home page.

Languages

This class handles the administration of languages tasks.

Logs

Dispatcher to show various kinds of logs.

Mail

Handles mail configuration, as well as reviewing the mail queue.

Maintenance

Forum maintenance. Important stuff.

Membergroups

This class is concerned with anything in the Manage Membergroups admin screen.

Members

Shows a list of members or a selection of members.

Mods

This my friend, is for all the mod authors out there.

News

This class manages... the news. :P

Permissions

Permissions handles all possible permission stuff.

Posts

This class contains all the administration settings for topics and posts.

Registration

This class helps the administrator setting registration settings and policy as well as allow the administrator to register new members themselves.

RepairBoards

This is here for the "repair any errors" feature in the admin center.

Reports

This class is exclusively for generating reports to help assist forum administrators keep track of their forum configuration and state.

Search

The admin screen to change the search settings.

SearchEngines

Manages the settings related to search engines.

Server

Contains all the functionality required to be able to edit the core server settings. This includes anything from which an error may result in the forum destroying itself in a firey fury.

Smileys

This class takes care of all administration of smileys.

Subscriptions

Contains all the administration functions for paid subscriptions.

Tasks

This class concerns itself with scheduled tasks management.

Themes

This class concerns itself almost completely with theme administration.

Warnings

Moderation type settings - although there are fewer than we have you believe ;)

Agreement

The purpose of this class is to show the user the registration agreement and privacy policy, and to ask the user to accept them if they haven't already done so.

AgreementAccept

Records when the user accepted the registration agreement and privacy policy.

Announce

This class handles sending announcements about topics.

AttachmentApprove

Allows the moderator to approve or reject attachments.

AttachmentDownload

Downloads an avatar or attachment based on $_GET['attach'], and increments the download count.

AttachmentUpload

This class handles adding/deleting attachments

AutoSuggest

Suggests members, membergroups, or SMF versions in reply to AJAX requests.

BoardIndex

This class shows the board index.

BuddyListToggle

This simple action adds/removes the passed user from the current user's buddy list.

Calendar

This class has only one real task, showing the calendar.

CoppaForm

Displays the COPPA form during registration.

Credits

This action prepares credit and copyright information for the credits page and the admin page.

Display

This class loads the posts in a topic so they can be displayed.

DisplayAdminFile

Get one of the admin information files from Simple Machines.

Feed

This class contains the code necessary to display XML feeds.

FindMember

Shows a popup to search for members.

Groups

Shows group info and allows certain priviledged members to add/remove members.

Help

This class has the important job of taking care of help messages and the help center.

HelpAdmin

Shows popup help for the admin (and moderators sometimes) to describe complex settings and such.

JavaScriptModify

Used to edit the body or subject of a message inline.

Like

Handles liking posts and displaying the list of who liked a post.

Login

Shows the login form.

Login2

Validates the submitted credentials and logs the user in if they pass.

LoginTFA

Handles Two-Factor Authentication credentials.

Logout

Logs the user out.

Memberlist

This class contains the methods for displaying and searching in the members list.

MessageIndex

This class shows the list of topics in a board.

EndSession

Ends a moderator session, requiring authentication to access the moderation center again.

Home

This is the home page of the moderation center.

Logs

The moderation and adminstration logs are this class's only job.

Main

This is the Moderation Center.

Posts

Handles things related to post moderation.

ReportedContent

Handles reported members and posts, as well as moderation comments.

ShowNotice

Shows a notice sent to a user.

Warnings

Allows the moderator to view stuff related to warnings.

WatchedUsers

Rename here and in the exportStatic call at the end of the file.

MsgDelete

This action handles the deletion of posts.

Notify

This abstract class contains the main functionality to toggle email notification preferences for topics, boards and announcements.

NotifyAnnouncements

Toggles email notification preferences for announcements.

NotifyBoard

Toggles email notification preferences for boards.

NotifyTopic

Toggles email notification preferences for topics.

PersonalMessage

This class is mainly meant for controlling the actions related to personal messages. It allows viewing, sending, deleting, and marking personal messages.

Post

This class handles posting and modifying replies and new topics.

Post2

This class handles posting and modifying replies and new topics.

Account

Handles the account section of the profile.

Activate

Activates an account.

AlertsPopup

Shows the popup for the current user's alerts.

BuddyIgnoreLists

Show all the users buddies, as well as a add/delete interface.

Delete

Handles deleting an account.

Export

This class contains functions to export a member's profile data to a downloadable file.

ExportAttachment

Downloads an attachment that was linked from a profile export.

ExportDownload

Downloads exported profile data file.

ForumProfile

Handles the main "Forum Profile" section of the profile.

GroupMembership

Allows a user to choose, or at least request, group memberships.

IgnoreBoards

Handles the "ignored boards" section of the profile (if enabled)

IssueWarning

Rename here and in the exportStatic call at the end of the file.

Main

This class has the primary job of showing and editing people's profiles.

Notification

Handles preferences related to notifications.

PaidSubs

Class for doing all the paid subscription stuff - kinda.

Popup

Shows the popup menu for the current user's profile.

ShowAlerts

Shows all alerts for a member.

ShowPermissions

Rename here and in the exportStatic call at the end of the file.

ShowPosts

Rename here and in the exportStatic call at the end of the file.

StatPanel

Rename here and in the exportStatic call at the end of the file.

Summary

Shows a summary of a member's profile.

TFADisable

Provides interface to disable two-factor authentication in SMF.

TFASetup

Provides interface to set up two-factor authentication in SMF.

ThemeOptions

Handles the "Look and Layout" section of the profile

Tracking

Rename here and in the exportStatic call at the end of the file.

ViewWarning

Rename here and in the exportStatic call at the end of the file.

QuickModeration

Handles moderation from the message index.

QuickModerationInTopic

Handles quick moderation actions from within a topic.

QuoteFast

This class handles quoting posts via JavaScript.

Recent

Finds and retrieves information about recently posted messages.

Register

Shows the registration form.

Register2

Actually registers the new member.

Reminder

Handle sending out reminders, and checking the secret answer and question.

ReportToMod

Deals with reporting posts or profiles to mods and admins.

RequestMembers

Outputs each member name on its own line.

Search

Shows the search form.

Search2

Shows the search form.

SendActivation

Despite the name, which is what it is for historical reasons, this action doesn't actually send anything. It just shows a message for a guest.

SmStats

Lets simplemachines.org gather statistics if, and only if, the admin allows.

Stats

Provides a display for forum statistics.

TopicMerge

Handles merging of topics.

TopicMove

This action provides UI to allow topics to be moved from one board to another.

TopicMove2

This action handles moving topics from one board to another board.

TopicPrint

This class formats a topic to be printer friendly.

TopicRemove

This action handles the deletion of topics.

TopicRestore

This action handles restoring a topic from the recycle board back to its original board.

TopicSplit

Handles splitting of topics.

TrackIP

Rename here and in the exportStatic call at the end of the file.

Unread

Finds and retrieves information about new posts and topics.

UnreadReplies

Finds and retrieves information about replies to the user's posts.

VerificationCode

Shows the verification code or let it be heard.

ViewQuery

Provides a way to view database queries. Used for debugging.

Who

Who's online, and what are they doing? This class prepares the who's online data for the Who template.

XmlHttp

Handles XML-based interaction (mainly XMLhttp)

Alert

Represents an alert and provides methods for working with alerts.

Attachment

This class represents a file attachment.

BBCodeParser

Parses Bulletin Board Code in a string and converts it to HTML.

Board

This class loads information about the current board, as well as other boards when needed. It also handles low-level tasks for managing boards, such as creating, deleting, and modifying them, as well as minor tasks relating to boards, such as marking them read.

BrowserDetector

Class BrowserDetector This class is an experiment for the job of correctly detecting browsers and settings needed for them.

CacheApi

Category

This class loads information about categories. It also handles low-level tasks for managing categories, such as creating, deleting, and modifying them.

Config

Handles loading and saving SMF's settings, both in Settings.php and database.

Cookie

Represents a cookie.

MySQL

Interacts with MySQL databases.

PostgreSQL

Interacts with PostgreSQL databases.

DatabaseApi

Class DatabaseApi

Draft

Represents a post draft.

Editor

Creates the editor input box so that people can write messages to post.

ErrorHandler

SMF's error handler.

Event

Represents a calendar event.

Forum

The root Forum class. Used when browsing the forum normally.

ColorTable

File

FileHeader

Image

ImageHeader

LzwCompression

Class LzwCompression

Image

Represents an image and allows low-level graphics operations to be performed, specially as needed for avatars, attachments, etc.

Group

Represents a member group.

IntegrationHook

Handles adding, removing, and calling hooked integration functions.

IP

Represents an IP address and allows performing various operations on it.

ItemList

This class provides a standard way of displaying lists for SMF.

Lang

Handles the localizable strings shown in SMF's user interface.

Logging

This class concerns itself with logging and tracking statistics.

Mail

Class for preparing and handling email messages.

Mentions

This really is a pseudo class, I couldn't justify having instance of it while mentioning so I just made every method static

Menu

Represents a menu, such as the admin menu or profile menu.

Msg

Class for a single posted message.

FtpConnection

Class FtpConnection Simple FTP protocol implementation.

PackageManager

This is the main package manager.

SubsPackage

Various utility functions for working with packages.

XmlArray

Class XmlArray Represents an XML array

PageIndex

Constructs a page list.

Conversation

Represents a collection of related personal messages.

DraftPM

Represents a personal message draft.

Folder

Represents a personal message folder (i.e. "inbox" or "sent items")

Label

Represents a personal message label.

PM

Represents a single personal message.

Popup

The popup menu for unread personal messages.

Received

This class represents the received copy of a personal message in a member's inbox. It has info such as whether the PM has been read by this member, deleted by the member, etc., and whether it was sent to this member as a visible recipient or as a hidden one (i.e a "BCC" recipient).

Rule

Represents a sorting rule that can be applied to incoming personal messages.

Search

Shows the search form.

SearchResult

Shows personal message search results.

Poll

Represents a poll.

PollChoice

Represents one of the choices a user can vote for in a poll.

Profile

Represents a member's profile as shown by ?action=profile.

ProxyServer

This is a lightweight proxy for serving images, generally meant to be used alongside SSL.

QueryString

Handles the query string, request variables, and session management.

Custom

Used for the "custom search index" option Class Custom

Fulltext

Class Fulltext Used for fulltext index searching

Standard

Standard non full index, non custom index search

SearchApi

Class SearchApi

SearchResult

Class for a single posted message.

Security

A collection of miscellaneous methods related to forum security.

SecurityToken

Represents a security token.

ServerSideIncludes

Performs all the necessary setup and security checks for SSI access, and provides a number of useful functions that allow external scripts to access SMF data.

Session

Implementation of PHP's session API.

Display

Class for returning available form data for this gateway

Payment

Class of functions to validate a IPN response and provide details of the payment

TaskRunner

Runs background tasks (a.k.a. cron jobs), including scheduled tasks.

ApprovePost_Notify

This class contains code used to notify moderators when there are posts that need to be approved.

ApproveReply_Notify

This class contains code used to notify a member when a moderator replied to the member's own unapproved topic.

BackgroundTask

Base class for all background tasks.

Birthday_Notify

This class contains code used to send out "Happy Birthday" emails.

Buddy_Notify

This class contains code used to notify members when they have been added to other members' buddy lists.

CreateAttachment_Notify

This class contains code used to notify moderators when there are attachments that need to be approved.

CreatePost_Notify

This class contains code used to notify people when a new post is created that is relevant to them in some way: new topics in boards they watch, replies to topics they watch, posts that mention them, and/or posts that quote them.

DailyMaintenance

Does some daily cleaning up.

EventNew_Notify

This class contains code used to notify people that a new event has been added to the calendar - but only when no topic has been created.

ExportProfileData

This class contains code used to incrementally export a member's profile data to one or more downloadable files.

FetchSMFiles

Retrieves data (e.g. last version of SMF) from simplemachines.org.

GenericScheduledTask

A class for running scheduled tasks with custom callable functions.

GroupAct_Notify

This class contains code used to notify a member when a group moderator has taken action on that member's request to join a group.

GroupReq_Notify

This class contains code used to notify group moderators that a member has requested to join the group.

Likes_Notify

This class contains code used to notify members when something is liked.

MemberReport_Notify

This class contains code used to notify moderators when someone files a report about another member's profile.

MemberReportReply_Notify

This class contains code used to notify a moderator when another moderator replies to a profile moderation report that the first mod has commented on.

MsgReport_Notify

This class contains code used to notify moderators when someone files a report about a message.

MsgReportReply_Notify

This class contains code used to notify a moderator when another moderator replies to a message moderation report that the first mod has commented on.

PaidSubs

Performs the standard checks on expiring/near expiring subscriptions.

PruneLogTopics

Prunes log_topics, log_boards, and log_mark_boards_read.

Register_Notify

This class contains code used to notify people when a new member new signs up.

RemoveOldDrafts

Check for old drafts and remove them.

RemoveTempAttachments

Removes old, unposted attachments from the attachment upload directory.

RemoveTopicRedirects

Deletes moved topic notices that have passed their best-by date.

ScheduledTask

Base class for scheduled tasks.

SendDigests

Send out a daily or weekly email of all subscribed topics.

UpdateTldRegex

This file contains code used to initiate updates of Config::$modSettings['tld_regex']

UpdateUnicode

This class contains code used to update SMF's Unicode data files.

WeeklyMaintenance

Does some weekly maintenance.

Theme

Represents a loaded theme. Also provides many theme-related static methods.

Time

Extends \DateTime with some extra features for SMF.

TimeZone

This class provides some methods to simplify working with time zones.

Topic

Represents a topic.

Utf8String

A class for manipulating UTF-8 strings.

Url

Represents a URL string and allows performing various operations on the URL.

User

Represents a user, including both guests and registered members.

Utils

Holds some widely used stuff, like $context and $smcFunc.

Uuid

Generates, compresses, and expands Univerally Unique Identifers.

Verifier

Sets up the anti-spam control that tries to verify the user's humanity.

CurlFetcher

Class CurlFetcher

FtpFetcher

Fetches data from FTP URLs.

SocketFetcher

Fetches data from HTTP URLs via socket connections.

WebFetchApi

Class SearchApi

Traits

ArrayAccessHelper

Simplifies and standardizes implementing \ArrayAccess.

BackwardCompatibility

Assists in providing backward compatibility with code written for earlier versions of SMF.

DynamicPropertyHelper

Simplifies and standardizes implementing dynamic properties.

Constants

DB_SCRIPT_VERSION  = '3-0'

EXPORTING  = 1

FROM_CLI  = empty($_SERVER['REQUEST_METHOD'])

IMAGETYPE_AVIF  = 19

JQUERY_VERSION  = '3.6.3'

JQUERY_VERSION  = '3.6.3'

JQUERY_VERSION  = '3.6.3'

MAX_CLAIM_THRESHOLD  = self::MAX_CLAIM_THRESHOLD

MAX_CRON_TIME  = self::MAX_CRON_TIME

MYSQL_TITLE  = 'MySQL'

MYSQL_TITLE  = 'MySQL'

MYSQL_TITLE  = 'MySQL'

POSTGRE_TITLE  = 'PostgreSQL'

POSTGRE_TITLE  = 'PostgreSQL'

POSTGRE_TITLE  = 'PostgreSQL'

SMF  = 'BACKGROUND'

SMF  = 1

SMF  = 1

SMF  = 'BACKGROUND'

SMF  = 1

SMF  = 'PROXY'

SMF  = 'SSI'

SMF_FULL_VERSION  = 'SMF ' . \SMF_VERSION

SMF_FULL_VERSION  = 'SMF ' . \SMF_VERSION

SMF_FULL_VERSION  = 'SMF ' . \SMF_VERSION

SMF_INSTALLING  = 1

SMF_INSTALLING  = 1

SMF_LANG_VERSION  = '3.0 Alpha 1'

SMF_SETTINGS_BACKUP_FILE  = \dirname(\SMF_SETTINGS_FILE) . '/' . \pathinfo(\SMF_SETTINGS_FILE, \PATHINFO_FILENAME) . '_bak.php'

SMF_SETTINGS_BACKUP_FILE  = __DIR__ . '/Settings_bak.php'

SMF_SETTINGS_BACKUP_FILE  = dirname(SMF_SETTINGS_FILE) . '/' . pathinfo(SMF_SETTINGS_FILE, PATHINFO_FILENAME) . '_bak.php'

SMF_SETTINGS_FILE  = __DIR__ . '/Settings.php'

SMF_SETTINGS_FILE  = __DIR__ . '/Settings.php'

SMF_SETTINGS_FILE  = $settingsFile

SMF_SOFTWARE_YEAR  = '2023'

SMF_SOFTWARE_YEAR  = '2023'

SMF_SOFTWARE_YEAR  = '2023'

SMF_UNICODE_VERSION  = '15.1.0.0'

SMF_USER_AGENT  = 'Mozilla/5.0 (' . \php_uname('s') . ' ' . \php_uname('m') . ') AppleWebKit/605.1.15 (KHTML, like Gecko) SMF/' . \strtr(\SMF_VERSION, ' ', '.')

SMF_USER_AGENT  = 'Mozilla/5.0 (' . \php_uname('s') . ' ' . \php_uname('m') . ') AppleWebKit/605.1.15 (KHTML, like Gecko) SMF/' . \strtr(\SMF_VERSION, ' ', '.')

SMF_USER_AGENT  = 'SMF'

SMF_USER_AGENT  = 'Mozilla/5.0 (' . \php_uname('s') . ' ' . \php_uname('m') . ') AppleWebKit/605.1.15 (KHTML, like Gecko) SMF/' . \strtr(\SMF_VERSION, ' ', '.')

SMF_VERSION  = '3.0 Alpha 1'

SMF_VERSION  = '3.0 Alpha 1'

SMF_VERSION  = '3.0 Alpha 1'

TIME_START  = \microtime(\true)

TIME_START  = \microtime(\true)

TIME_START  = \microtime(\true)

TIME_START  = \microtime(\true)

Functions

initialize_inputs()  : mixed

load_lang_file()  : mixed

load_database()  : mixed

installExit()  : mixed

Welcome()  : mixed

CheckFilesWritable()  : mixed

DatabaseSettings()  : mixed

ForumSettings()  : mixed

DatabasePopulation()  : mixed

AdminAccount()  : mixed

DeleteInstall()  : mixed

installer_updateSettingsFile()  : mixed

fixModSecurity()  : mixed

template_install_above()  : mixed

template_install_below()  : mixed

template_welcome_message()  : mixed

template_warning_divs()  : mixed

template_chmod_files()  : mixed

template_database_settings()  : mixed

template_forum_settings()  : mixed

template_populate_database()  : mixed

template_admin_account()  : mixed

template_delete_install()  : mixed

upgrade_clean_cache()  : mixed

Clean the cache using the SMF 2.1 CacheAPI.

getMemberGroups()  : array<string|int, mixed>

Returns a list of member groups. Used to upgrade 1.0 and 1.1.

makeFilesWritable()  : bool

Make files writable. First try to use regular chmod, but if that fails, try to use FTP.

quickFileWritable()  : bool

The quick version of makeFilesWritable, which does not support FTP.

deleteFile()  : mixed

Delete a file. Check permissions first, just in case.

print_error()  : mixed

Prints an error to stderr.

throw_error()  : bool

Throws a graphical error message.

smf_mysql_fetch_assoc()  : array<string|int, mixed>|null

smf_mysql_fetch_row()  : array<string|int, mixed>|null

smf_mysql_free_result()  : mixed

smf_mysql_insert_id()  : int|string

smf_mysql_num_rows()  : int

smf_mysql_real_escape_string()  : mixed

array_column()  : mixed

upgradeCacheSettings()  : string

Creates the json_encoded array for the current cache option.

upgradeExit()  : mixed

findSettingsFile()  : mixed

load_lang_file()  : mixed

redirectLocation()  : mixed

loadEssentialData()  : mixed

initialize_inputs()  : mixed

WelcomeLogin()  : mixed

checkFolders()  : mixed

checkLogin()  : mixed

UpgradeOptions()  : mixed

BackupDatabase()  : mixed

backupTable()  : mixed

DatabaseChanges()  : mixed

setSqlMode()  : mixed

DeleteUpgrade()  : mixed

cli_scheduled_fetchSMfiles()  : mixed

convertSettingsToTheme()  : mixed

convertSettingstoOptions()  : mixed

php_version_check()  : mixed

db_version_check()  : mixed

fixRelativePath()  : mixed

parse_sql()  : mixed

upgrade_query()  : mixed

protected_alter()  : mixed

textfield_alter()  : mixed

Alter a text column definition preserving its character set.

nextSubstep()  : mixed

cmdStep0()  : mixed

ConvertUtf8()  : mixed

Handles converting your database to UTF-8

upgrade_unserialize()  : string|bool

Wrapper for unserialize that attempts to repair corrupted serialized data strings

serialize_to_json()  : mixed

template_chmod()  : mixed

template_upgrade_above()  : mixed

template_upgrade_below()  : mixed

template_xml_above()  : mixed

template_xml_below()  : mixed

template_error_message()  : mixed

template_welcome_message()  : mixed

template_upgrade_options()  : mixed

template_backup_database()  : mixed

template_backup_xml()  : mixed

template_database_changes()  : mixed

template_database_xml()  : mixed

template_convert_utf8()  : mixed

template_convert_xml()  : mixed

template_serialize_json()  : mixed

template_serialize_json_xml()  : mixed

template_upgrade_complete()  : mixed

MySQLConvertOldIp()  : bool

Convert MySQL (var)char ip col to binary

upgradeGetColumnInfo()  : array<string|int, mixed>

Get the column info. This is basically the same as smf_db_list_columns but we get 1 column, force detail and other checks.

smf_crc32()  : string

Compatibility function.

idn_to_ascii()  : string|bool

Compatibility function.

idn_to_utf8()  : string|bool

Compatibility function.

utf8_casefold_simple_maps()  : array<string|int, mixed>

Helper function for utf8_casefold.

utf8_casefold_maps()  : array<string|int, mixed>

Helper function for utf8_casefold.

utf8_strtolower_simple_maps()  : array<string|int, mixed>

Helper function for utf8_strtolower.

utf8_strtolower_maps()  : array<string|int, mixed>

Helper function for utf8_strtolower.

utf8_titlecase_simple_maps()  : array<string|int, mixed>

Helper function for utf8_convert_case.

utf8_titlecase_maps()  : array<string|int, mixed>

Helper function for utf8_convert_case.

utf8_strtoupper_simple_maps()  : array<string|int, mixed>

Helper function for utf8_strtoupper.

utf8_strtoupper_maps()  : array<string|int, mixed>

Helper function for utf8_strtoupper.

utf8_combining_classes()  : array<string|int, mixed>

Helper function for utf8_normalize_d.

utf8_compose_maps()  : array<string|int, mixed>

Helper function for utf8_compose.

utf8_normalize_d_maps()  : array<string|int, mixed>

Helper function for utf8_normalize_d.

utf8_normalize_kd_maps()  : array<string|int, mixed>

Helper function for utf8_normalize_kd.

utf8_default_ignorables()  : array<string|int, mixed>

Helper function for utf8_normalize_kc_casefold.

idna_maps()  : array<string|int, mixed>

Helper function for idn_to_* polyfills.

idna_maps_deviation()  : array<string|int, mixed>

Helper function for idn_to_* polyfills.

idna_maps_not_std3()  : array<string|int, mixed>

Helper function for idn_to_* polyfills.

idna_regex()  : array<string|int, mixed>

Helper function for idn_to_* polyfills.

utf8_regex_quick_check()  : array<string|int, mixed>

Helper function for utf8_is_normalized.

utf8_regex_properties()  : array<string|int, mixed>

Helper function for utf8_sanitize_invisibles and utf8_convert_case.

utf8_regex_variation_selectors()  : array<string|int, mixed>

Helper function for utf8_sanitize_invisibles.

utf8_regex_joining_type()  : array<string|int, mixed>

Helper function for utf8_sanitize_invisibles.

utf8_regex_indic()  : array<string|int, mixed>

Helper function for utf8_sanitize_invisibles.

template_ssi_above()  : mixed

Displays the header for this file

template_ssi_below()  : mixed

Displays the footer for this file

template_homepage_sample1()  : string|void

Displays a sample homepage to give you an idea of what's possible using SSI functions

template_homepage_sample1_php()  : mixed

Generates the sample homepage. Used with template_homepage_sample1 if $method isn't 'source'.

template_homepage_sample1_html()  : string

Generates the HTML for the homepage sample. Used in conjunction with template_homepage_sample1 if method is 'source'

generateSubscriptionError()  : mixed

Log an error then exit

template_admin()  : mixed

This is the administration center home.

template_credits()  : mixed

Show some support information and credits to those who helped make this.

template_view_versions()  : mixed

Displays information about file versions installed, and compares them to current version.

template_edit_censored()  : mixed

Form for stopping people using naughty words, etc.

template_not_done()  : mixed

This is the page shown when we've temporarily paused things such as during maintenance tasks, sending newsletters, etc.

template_show_settings()  : mixed

Template for showing settings (Of any kind really!)

template_show_custom_profile()  : mixed

Template for showing custom profile fields.

template_edit_profile_field()  : mixed

Template for editing a custom profile field

template_admin_search_results()  : mixed

Results page for an admin search.

template_callback_question_answer_list()  : mixed

This little beauty shows questions and answer from the captcha type feature.

template_repair_boards()  : mixed

Repairing boards.

template_php_info()  : mixed

Retrieves info from the php_info function, scrubs and preps it for display

template_clean_cache_button_above()  : mixed

Content shown above the clean cache button

template_clean_cache_button_below()  : mixed

Content shown below the clean cache button?

template_admin_quick_search()  : mixed

This shows the admin search form

template_main()  : mixed

template_boardindex_outer_above()  : mixed

The top part of the outer layer of the boardindex

template_newsfader()  : mixed

This shows the newsfader

template_main()  : mixed

This actually displays the board index

template_bi_board_icon()  : mixed

Outputs the board icon for a standard board.

template_bi_redirect_icon()  : mixed

Outputs the board icon for a redirect.

template_bi_board_info()  : mixed

Outputs the board info for a standard board or redirect.

template_bi_board_stats()  : mixed

Outputs the board stats for a standard board.

template_bi_redirect_stats()  : mixed

Outputs the board stats for a redirect.

template_bi_board_lastpost()  : mixed

Outputs the board lastposts for a standard board or a redirect.

template_bi_board_children()  : mixed

Outputs the board children for a standard board.

template_boardindex_outer_below()  : mixed

The lower part of the outer layer of the board index

template_info_center()  : mixed

Displays the info center

template_ic_block_recent()  : mixed

The recent posts section of the info center

template_ic_block_calendar()  : mixed

The calendar section of the info center

template_ic_block_stats()  : mixed

The stats section of the info center

template_ic_block_online()  : mixed

The who's online section of the info center

template_main()  : mixed

Our main calendar template, which encapsulates weeks and months.

template_show_upcoming_list()  : void|bool

Display a list of upcoming events, birthdays, and holidays.

template_show_month_grid()  : void|bool

Display a monthly calendar grid.

template_show_week_grid()  : void|bool

Shows a weekly grid

template_calendar_top()  : mixed

Calendar controls under the title

template_event_post()  : mixed

Template for posting a calendar event.

template_bcd()  : mixed

Displays a clock

template_hms()  : mixed

Displays the hours, minutes and seconds for our clock

template_omfg()  : mixed

Displays a binary clock

template_thetime()  : mixed

Displays the time

template_main()  : mixed

This template handles displaying a topic

template_single_post()  : mixed

Template for displaying a single post.

template_quickreply()  : mixed

The template for displaying the quick reply box.

template_fatal_error()  : mixed

THis displays a fatal error message

template_error_log()  : mixed

This template handles the error log in the admin center.

template_show_file()  : mixed

This template shows a snippet of code from a file and highlights which line caused the error.

template_attachment_errors()  : mixed

This template handles showing attachment-related errors

template_show_backtrace()  : mixed

This template shows a backtrace of the given error

template_control_richedit()  : mixed

This function displays all the stuff you get with a richedit box - BBC, smileys, etc.

template_control_richedit_buttons()  : mixed

This template shows the form buttons at the bottom of the editor

template_control_verification()  : bool

This template displays a verification form

template_show_list()  : mixed

This template handles displaying a list

template_additional_rows()  : mixed

This template displays additional rows above or below the list.

template_generic_menu_dropdown_above()  : mixed

This contains the HTML for the menu bar at the top of the admin center.

template_generic_menu_dropdown_below()  : mixed

Part of the admin layer - used with generic_menu_dropdown_above to close the admin content div.

template_generic_menu()  : mixed

The template for displaying a menu

template_generic_menu_tabs()  : mixed

The code for displaying the menu

template_popup()  : mixed

This displays a help popup thingy

template_find_members()  : mixed

The template for the popup for finding members

template_manual()  : mixed

The main help page

template_init()  : mixed

Initialize the template... mainly little settings.

template_html_above()  : mixed

The main sub template above the content.

template_body_above()  : mixed

The upper part of the main template layer. This is the stuff that shows above the main forum content.

template_body_below()  : mixed

The stuff shown immediately below the main content, including the footer

template_html_below()  : mixed

This shows any deferred JavaScript and closes out the HTML

theme_linktree()  : mixed

Show a linktree. This is that thing that shows "My Community | General Category | General Discussion".

template_menu()  : mixed

Show the menu up top. Something like [home] [help] [profile] [logout].

template_button_strip()  : mixed

Generate a strip of buttons.

template_quickbuttons()  : void|string

Generate a list of quickbuttons.

template_maint_warning_above()  : mixed

The upper part of the maintenance warning box

template_maint_warning_below()  : mixed

The lower part of the maintenance warning box.

template_popup()  : mixed

This shows the popup that shows who likes a particular post.

template_like()  : mixed

Display a like button and info about how many people liked something

template_generic()  : mixed

A generic template that outputs any data passed to it.

template_login()  : mixed

This is just the basic "login" form.

template_login_tfa()  : mixed

TFA authentication form

template_kick_guest()  : mixed

Tell a guest to get lost or login!

template_maintenance()  : mixed

This is for maintenance mode.

template_admin_login()  : mixed

This is for the security stuff - makes administrators login every so often.

template_retry_activate()  : mixed

Activate your account manually?

template_resend()  : mixed

The form for resending the activation code.

template_logout()  : mixed

Confirm a logout.

template_avatar_settings_above()  : mixed

This template wraps around the simple settings page to add javascript functionality.

template_avatar_settings_below()  : mixed

JavaScript to be output below the simple settings page

template_maintenance()  : mixed

The attachment maintenance page

template_attachment_repair()  : mixed

The file repair page

template_attachment_paths()  : mixed

The page that handles managing attachment paths.

template_ban_edit()  : mixed

Add or edit a ban

template_ban_edit_trigger()  : mixed

Add or edit a ban trigger

template_main()  : mixed

Template for listing all the current categories and boards.

template_modify_category()  : mixed

Template for editing/adding a category on the forum.

template_confirm_category_delete()  : mixed

A template to confirm if a user wishes to delete a category - and whether they want to save the boards.

template_modify_board()  : mixed

Below is the template for adding/editing a board on the forum.

template_confirm_board_delete()  : mixed

A template used when a user is deleting a board with child boards in it - to see what they want to do with them.

template_edit_holiday()  : mixed

Editing or adding holidays.

template_download_language()  : mixed

Download a new language file.

template_modify_language_entries()  : mixed

Edit language entries. Note that this doesn't always work because of PHP's max_post_vars setting.

template_add_language()  : mixed

Add a new language

template_browse()  : mixed

Template for browsing the mail queue.

template_mailtest()  : mixed

Template for testing mail send.

template_maintain_database()  : mixed

Template for the database maintenance tasks.

template_maintain_routine()  : mixed

Template for the routine maintenance tasks.

template_maintain_members()  : mixed

Template for the member maintenance tasks.

template_maintain_topics()  : mixed

Template for the topic maintenance tasks.

template_optimize()  : mixed

Simple template for showing results of our optimization.

template_convert_entities()  : mixed

Template for converting entities to UTF-8 characters

template_convert_msgbody()  : mixed

Template for converting posts to UTF-8.

template_main()  : mixed

The main page listing all the groups.

template_new_group()  : mixed

Add a new membergroup.

template_edit_group()  : mixed

Edit an existing membergroup.

template_add_edit_group_boards_list()  : mixed

The template for determining which boards a group has access to.

template_group_members()  : mixed

Template for viewing the members of a group.

template_group_request_reason()  : mixed

Allow the moderator to enter a reason to each user being rejected.

template_search_members()  : mixed

The admin member search form

template_admin_browse()  : mixed

The admin member list.

template_email_members()  : mixed

The template for sending newsletters

template_email_members_compose()  : mixed

The form for composing a newsletter

template_email_members_send()  : mixed

The page shown while the newsletter is being sent

template_news_lists()  : mixed

The settings page.

template_modify_subscription()  : mixed

The template for adding or editing a subscription.

template_delete_subscription()  : mixed

The page for deleting a subscription.

template_modify_user_subscription()  : mixed

Add or edit an existing subscriber.

template_user_subscription()  : mixed

Template for a user to edit/pick their subscriptions.

template_choose_payment()  : mixed

The "choose payment" dialog.

template_paid_done()  : mixed

The "thank you" bit.

template_permission_index()  : mixed

The main manage permissions page

template_by_board()  : mixed

THe page that shows which permissions profile applies to each board

template_edit_profiles()  : mixed

Edit permission profiles (predefined).

template_modify_group()  : mixed

Modify a group's permissions

template_modify_group_display()  : mixed

The way of looking at permissions.

template_inline_permissions()  : mixed

A form for displaying inline permissions, such as on a settings page.

template_postmod_permissions()  : mixed

Edit post moderation permissions.

template_view_scheduled_tasks()  : mixed

Template for listing all scheduled tasks.

template_edit_scheduled_tasks()  : mixed

A template for, you guessed it, editing a task!

template_modify_weights()  : mixed

Modify the search weights.

template_select_search_method()  : mixed

Select the search method.

template_create_index()  : mixed

Create a search index.

template_create_index_progress()  : mixed

Display a progress page while creating a search index.

template_create_index_done()  : mixed

Done creating a search index.

template_spider_edit()  : mixed

Add or edit a search engine spider.

template_show_spider_logs()  : mixed

Show... spider... logs.

template_show_spider_stats()  : mixed

Show... spider... stats.

template_editsets()  : mixed

Shows a list of smiley sets so you can edit them.

template_modifyset()  : mixed

Modifying a smiley set.

template_modifysmiley()  : mixed

Editing an individual smiley

template_addsmiley()  : mixed

Adding a new smiley.

template_setorder()  : mixed

Ordering smileys.

template_editicons()  : mixed

Editing Message Icons

template_editicon()  : mixed

Editing an individual message icon

template_main()  : mixed

Displays a sortable listing of all members registered on the forum.

template_search()  : mixed

A page allowing people to search the member list.

template_main()  : mixed

The main messageindex.

template_bi_board_icon()  : mixed

Outputs the board icon for a standard board.

template_bi_redirect_icon()  : mixed

Outputs the board icon for a redirect.

template_bi_board_info()  : mixed

Outputs the board info for a standard board or redirect.

template_bi_board_stats()  : mixed

Outputs the board stats for a standard board.

template_bi_redirect_stats()  : mixed

Outputs the board stats for a redirect.

template_bi_board_lastpost()  : mixed

Outputs the board lastposts for a standard board or a redirect.

template_bi_board_children()  : mixed

Outputs the board children for a standard board.

template_topic_legend()  : mixed

Shows a legend for topic icons.

template_moderation_center()  : mixed

The main moderation center.

template_group_requests_block()  : mixed

Show all the group requests the user can see.

template_watched_users()  : mixed

A list of watched users

template_reported_posts_block()  : mixed

A list of reported posts

template_reported_users_block()  : mixed

A list of reported users

template_notes()  : mixed

Little section for making... notes.

template_unapproved_posts()  : mixed

Show a list of all the unapproved posts

template_user_watch_post_callback()  : string

Callback function for showing a watched users post in the table.

template_moderation_settings()  : mixed

The moderation settings page.

template_show_notice()  : mixed

Show a notice sent to a user.

template_warn_template()  : mixed

Add or edit a warning template.

template_move()  : mixed

Show an interface for selecting which board to move a post to.

template_redirect_options()  : mixed

Redirection topic options

template_merge_done()  : mixed

Confirmation page shown when finished merging topics.

template_merge()  : mixed

Merge topic page.

template_merge_extra_options()  : mixed

Extra options related to merging topics.

template_main()  : mixed

The main notification bar.

template_notify_board()  : mixed

Board notification bar.

template_notify_announcements()  : mixed

template_notify_pref_changed()  : mixed

Displays a message indicating the user's notification preferences were successfully changed

template_main()  : mixed

The main template

template_view_package()  : mixed

View package details when installing/uninstalling

template_extract_package()  : mixed

Extract package contents

template_list()  : mixed

List files in a package

template_examine()  : mixed

Examine a single file within a package

template_browse()  : mixed

List all packages

template_servers()  : mixed

List package servers

template_package_confirm()  : mixed

Confirm package operation

template_package_list()  : mixed

List packages.

template_downloaded()  : mixed

Confirmation page showing a package was uploaded/downloaded successfully.

template_install_options()  : mixed

Installation options - FTP info and backup settings

template_control_chmod()  : bool

CHMOD control form

template_ftp_required()  : mixed

Wrapper for the above template function showing that FTP is required

template_view_operations()  : mixed

View operation details.

template_file_permissions()  : mixed

The file permissions page.

template_permission_show_contents()  : mixed

Shows permissions for items within a directory (called from template_file_permissions)

template_action_permissions()  : mixed

A progress page showing what permissions changes are being applied

template_pm_above()  : mixed

This is for stuff above the menu in the personal messages section

template_pm_below()  : mixed

Just the end of the index bar, nothing special.

template_pm_popup()  : mixed

Displays a popup with information about your personal messages

template_folder()  : mixed

Shows a particular folder (eg inbox or outbox), all the PMs in it, etc.

template_single_pm()  : mixed

Template for displaying a single personal message.

template_subject_list()  : mixed

Just list all the personal message subjects - to make templates easier.

template_search()  : mixed

The form for the PM search feature

template_search_results()  : mixed

Displays results from a PM search

template_send()  : mixed

The form for sending a new PM

template_ask_delete()  : mixed

This template asks the user whether they wish to empty out their folder/messages.

template_prune()  : mixed

This template asks the user what messages they want to prune.

template_labels()  : mixed

Here we allow the user to setup labels, remove labels and change rules for labels (i.e, do quite a bit)

template_report_message()  : mixed

Template for reporting a personal message.

template_report_message_complete()  : mixed

Little template just to say "Yep, it's been submitted"

template_rules()  : mixed

Manage rules.

template_add_rule()  : mixed

Template for adding/editing a rule.

template_showPMDrafts()  : mixed

Template for showing all of a user's PM drafts.

template_main()  : mixed

A form for creating and/or editing a poll.

template_main()  : mixed

The main template for the post page.

template_spellcheck()  : mixed

The template for the spellchecker.

template_quotefast()  : mixed

The template for the AJAX quote feature

template_announce()  : mixed

The form for sending out an announcement

template_announcement_send()  : mixed

The confirmation/progress page, displayed after the admin has clicked the button to send the announcement.

template_post_header()  : mixed

Prints the input fields in the form's header (subject, message icon, guest name & email, etc.)

template_print_above()  : mixed

The header. Defines the look and layout of the page as well as a form for choosing print options.

template_main()  : mixed

The main page. This shows the relevant info in a printer-friendly format

template_print_below()  : mixed

The footer.

template_print_options()  : mixed

Displays the print page options

template_profile_above()  : mixed

Minor stuff shown above the main profile - mostly used for error messages and showing that the profile update was successful.

template_profile_below()  : mixed

Template for any HTML needed below the profile (closing off divs/tables, etc.)

template_profile_popup()  : mixed

Template for showing off the spiffy popup of the menu

template_alerts_popup()  : mixed

The "popup" showing the user's alerts

template_alerts_all_read()  : mixed

A simple template to say "You don't have any unread alerts".

template_summary()  : mixed

This template displays a user's details without any option to edit them.

template_showPosts()  : mixed

Template for showing all the posts of the user, in chronological order.

template_showAlerts()  : mixed

Template for showing all alerts

template_showDrafts()  : mixed

Template for showing all of a user's drafts

template_editBuddies()  : mixed

Template for showing and managing the buddy list.

template_editIgnoreList()  : mixed

Template for showing the ignore list of the current user.

template_trackActivity()  : mixed

This template shows an admin information on a users IP addresses used and errors attributed to them.

template_trackIP()  : mixed

The template for trackIP, allowing the admin to see where/who a certain IP has been used.

template_showPermissions()  : mixed

This template shows an admin which permissions a user have and which group(s) give them each permission.

template_statPanel()  : mixed

Template for user statistics, showing graphs and the like.

template_edit_options()  : mixed

Template for editing profile options.

template_profile_pm_settings()  : mixed

Personal Message settings.

template_profile_theme_settings()  : mixed

Template for showing theme settings. Note: template_options() actually adds the theme specific options.

template_alert_configuration()  : mixed

The template for configuring alerts

template_alert_notifications_topics()  : mixed

Template for showing which topics you're subscribed to

template_alert_notifications_boards()  : mixed

Template for showing which boards you're subscribed to

template_groupMembership()  : mixed

Template for choosing group membership.

template_ignoreboards()  : mixed

Template for managing ignored boards

template_load_warning_variables()  : mixed

Simply loads some theme variables common to several warning templates.

template_viewWarning()  : mixed

Template for viewing a user's warnings

template_issueWarning()  : mixed

Template for issuing warnings

template_deleteAccount()  : mixed

Template to show for deleting a user's account - now with added delete post capability!

template_profile_save()  : mixed

Template for the password box/save button stuck at the bottom of every profile page.

template_error_message()  : mixed

Small template for showing an error message upon a save problem in the profile.

template_profile_group_manage()  : mixed

Display a load of drop down selectors for allowing the user to change group.

template_profile_birthdate()  : mixed

Callback function for entering a birthdate!

template_profile_signature_modify()  : mixed

Show the signature editing box?

template_profile_avatar_select()  : mixed

Template for selecting an avatar

template_max_size()  : mixed

This is just a really little helper to avoid duplicating code unnecessarily

template_profile_timeformat_modify()  : mixed

Select the time format!

template_profile_theme_pick()  : mixed

Template for picking a theme

template_profile_smiley_pick()  : mixed

Smiley set picker.

template_tfasetup()  : mixed

Template for setting up and managing Two-Factor Authentication.

template_tfadisable()  : mixed

Template for disabling two-factor authentication.

template_tfasetup_backup()  : mixed

Template for setting up 2FA backup code

template_profile_tfa()  : mixed

Simple template for showing the 2FA area when editing a profile.

template_export_profile_data()  : mixed

Template for initiating and retrieving profile data exports

template_recent()  : mixed

Template for showing recent posts

template_unread()  : mixed

Template for showing unread posts

template_replies()  : mixed

Template for showing unread replies (eg new replies to topics you've posted in)

template_registration_agreement()  : mixed

Before showing users a registration form, show them the registration agreement.

template_registration_form()  : mixed

Before registering - get their information.

template_after()  : mixed

After registration... all done ;).

template_coppa()  : mixed

Template for giving instructions about COPPA activation.

template_coppa_form()  : mixed

An easily printable form for giving permission to access the forum for a minor.

template_verification_sound()  : mixed

Show a window containing the spoken verification code.

template_admin_register()  : mixed

The template for the form allowing an admin to register a user from the admin center.

template_edit_agreement()  : mixed

Form for editing the agreement shown for people registering to the forum.

template_edit_reserved_words()  : mixed

Template for editing reserved words.

template_edit_privacy_policy()  : mixed

template_main()  : mixed

The main "Here's how you can reset your password" page

template_reminder_pick()  : mixed

The page to pick an option - secret question/answer (if set) or email

template_sent()  : mixed

Just a simple "We sent you an email. Click the link in it to continue." message

template_set_password()  : mixed

Template for setting the new password

template_ask()  : mixed

The page that asks a user to answer their secret question

template_reported_posts()  : mixed

Displays all reported posts.

template_reported_posts_block()  : mixed

A block to show the current top reported posts.

template_viewmodreport()  : mixed

Handles viewing details of and managing a specific report

template_edit_comment()  : mixed

Template for editing a mod comment.

template_reported_members_block()  : mixed

A block to show the current top reported member profiles.

template_reported_members()  : mixed

Lists all reported members

template_viewmemberreport()  : mixed

Template for viewing and managing a specific report about a user's profile

template_report_type()  : mixed

Choose which type of report to run?

template_main()  : mixed

This is the standard template for showing reports.

template_print_above()  : mixed

Header of the print page!

template_print()  : mixed

The main print page

template_print_below()  : mixed

Footer of the print page.

template_main()  : mixed

The main "report this to the moderator" page

template_main()  : mixed

The main search form

template_results()  : mixed

The search results page.

template_options()  : mixed

This pseudo-template defines all the theme options

template_settings()  : mixed

This pseudo-template defines all the available theme settings (but not their actual values)

template_ask()  : mixed

The form that asks how you want to split things

template_main()  : mixed

A simple confirmation that things were split as expected, with links to the current board and the old and new topics.

template_select()  : mixed

The form for selecting which posts to split.

template_main()  : mixed

The stats page.

template_main()  : mixed

The main sub template - for theme administration.

template_list_themes()  : mixed

This lists all themes

template_reset_list()  : mixed

This lets you reset themes

template_set_options()  : mixed

This displays the form for setting theme options

template_set_settings()  : mixed

The page for setting and managing theme settings.

template_pick()  : mixed

This template allows for the selection of different themes ;)

template_installed()  : mixed

Okay, that theme was installed/updated successfully!

template_edit_list()  : mixed

The page for editing themes.

template_copy_template()  : mixed

The page allowing you to copy a template from one theme to another.

template_edit_browse()  : mixed

This lets you browse a list of files in a theme so you can choose which one to edit.

template_edit_style()  : mixed

Wanna edit the stylesheet?

template_edit_template()  : mixed

This edits the template.

template_edit_file()  : mixed

This allows you to edit a file

template_main()  : mixed

This handles the Who's Online page

template_credits()  : mixed

This displays a nice credits page

template_sendbody()  : mixed

This defines the XML for sending the body of a message

template_quotefast()  : mixed

This defines the XML for the AJAX quote feature

template_modifyfast()  : mixed

This defines the XML for the inline edit feature

template_modifydone()  : mixed

The XML for handling things when you're done editing a post inline

template_modifytopicdone()  : mixed

This handles things when editing a topic's subject from the messageindex.

template_post()  : mixed

The massive XML for previewing posts.

template_pm()  : mixed

All the XML for previewing a PM

template_warning()  : mixed

The XML for previewing a warning

template_stats()  : mixed

The XML for hiding/showing stats sections via AJAX

template_split()  : mixed

The XML for selecting items to split

template_button_strip()  : mixed

template_menu()  : mixed

theme_linktree()  : mixed

template_results()  : mixed

XML for search results

template_jump_to()  : mixed

The XML for the Jump To box

template_message_icons()  : mixed

The XML for displaying a column of message icons and selecting one via AJAX

template_check_username()  : mixed

The XML for instantly showing whether a username is valid on the registration page

template_generic_xml()  : mixed

This prints XML in its most generic form.

template_generic_xml_recursive()  : mixed

Recursive function for displaying generic XML data.