API Documentation
Table of Contents
Namespaces
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.
- 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.
Constants
DB_SCRIPT_VERSION
public
mixed
DB_SCRIPT_VERSION
= '3-0'
EXPORTING
public
mixed
EXPORTING
= 1
FROM_CLI
public
mixed
FROM_CLI
= empty($_SERVER['REQUEST_METHOD'])
IMAGETYPE_AVIF
public
mixed
IMAGETYPE_AVIF
= 19
JQUERY_VERSION
public
mixed
JQUERY_VERSION
= '3.6.3'
JQUERY_VERSION
public
mixed
JQUERY_VERSION
= '3.6.3'
JQUERY_VERSION
public
mixed
JQUERY_VERSION
= '3.6.3'
MAX_CLAIM_THRESHOLD
public
mixed
MAX_CLAIM_THRESHOLD
= self::MAX_CLAIM_THRESHOLD
MAX_CRON_TIME
public
mixed
MAX_CRON_TIME
= self::MAX_CRON_TIME
MYSQL_TITLE
public
mixed
MYSQL_TITLE
= 'MySQL'
MYSQL_TITLE
public
mixed
MYSQL_TITLE
= 'MySQL'
MYSQL_TITLE
public
mixed
MYSQL_TITLE
= 'MySQL'
POSTGRE_TITLE
public
mixed
POSTGRE_TITLE
= 'PostgreSQL'
POSTGRE_TITLE
public
mixed
POSTGRE_TITLE
= 'PostgreSQL'
POSTGRE_TITLE
public
mixed
POSTGRE_TITLE
= 'PostgreSQL'
SMF
public
mixed
SMF
= 'BACKGROUND'
SMF
public
mixed
SMF
= 1
SMF
public
mixed
SMF
= 1
SMF
public
mixed
SMF
= 'BACKGROUND'
SMF
public
mixed
SMF
= 1
SMF
public
mixed
SMF
= 'PROXY'
SMF
public
mixed
SMF
= 'SSI'
SMF_FULL_VERSION
public
mixed
SMF_FULL_VERSION
= 'SMF ' . \SMF_VERSION
SMF_FULL_VERSION
public
mixed
SMF_FULL_VERSION
= 'SMF ' . \SMF_VERSION
SMF_FULL_VERSION
public
mixed
SMF_FULL_VERSION
= 'SMF ' . \SMF_VERSION
SMF_INSTALLING
public
mixed
SMF_INSTALLING
= 1
SMF_INSTALLING
public
mixed
SMF_INSTALLING
= 1
SMF_LANG_VERSION
public
mixed
SMF_LANG_VERSION
= '3.0 Alpha 1'
SMF_SETTINGS_BACKUP_FILE
public
mixed
SMF_SETTINGS_BACKUP_FILE
= \dirname(\SMF_SETTINGS_FILE) . '/' . \pathinfo(\SMF_SETTINGS_FILE, \PATHINFO_FILENAME) . '_bak.php'
SMF_SETTINGS_BACKUP_FILE
public
mixed
SMF_SETTINGS_BACKUP_FILE
= __DIR__ . '/Settings_bak.php'
SMF_SETTINGS_BACKUP_FILE
public
mixed
SMF_SETTINGS_BACKUP_FILE
= dirname(SMF_SETTINGS_FILE) . '/' . pathinfo(SMF_SETTINGS_FILE, PATHINFO_FILENAME) . '_bak.php'
SMF_SETTINGS_FILE
public
mixed
SMF_SETTINGS_FILE
= __DIR__ . '/Settings.php'
SMF_SETTINGS_FILE
public
mixed
SMF_SETTINGS_FILE
= __DIR__ . '/Settings.php'
SMF_SETTINGS_FILE
public
mixed
SMF_SETTINGS_FILE
= $settingsFile
SMF_SOFTWARE_YEAR
public
mixed
SMF_SOFTWARE_YEAR
= '2023'
SMF_SOFTWARE_YEAR
public
mixed
SMF_SOFTWARE_YEAR
= '2023'
SMF_SOFTWARE_YEAR
public
mixed
SMF_SOFTWARE_YEAR
= '2023'
SMF_UNICODE_VERSION
public
mixed
SMF_UNICODE_VERSION
= '15.1.0.0'
SMF_USER_AGENT
public
mixed
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
public
mixed
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
public
mixed
SMF_USER_AGENT
= 'SMF'
SMF_USER_AGENT
public
mixed
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
public
mixed
SMF_VERSION
= '3.0 Alpha 1'
SMF_VERSION
public
mixed
SMF_VERSION
= '3.0 Alpha 1'
SMF_VERSION
public
mixed
SMF_VERSION
= '3.0 Alpha 1'
TIME_START
public
mixed
TIME_START
= \microtime(\true)
TIME_START
public
mixed
TIME_START
= \microtime(\true)
TIME_START
public
mixed
TIME_START
= \microtime(\true)
TIME_START
public
mixed
TIME_START
= \microtime(\true)
Functions
initialize_inputs()
initialize_inputs() : mixed
load_lang_file()
load_lang_file() : mixed
load_database()
load_database() : mixed
installExit()
installExit([mixed $fallThrough = false ]) : mixed
Parameters
- $fallThrough : mixed = false
Welcome()
Welcome() : mixed
CheckFilesWritable()
CheckFilesWritable() : mixed
DatabaseSettings()
DatabaseSettings() : mixed
ForumSettings()
ForumSettings() : mixed
DatabasePopulation()
DatabasePopulation() : mixed
AdminAccount()
AdminAccount() : mixed
DeleteInstall()
DeleteInstall() : mixed
installer_updateSettingsFile()
installer_updateSettingsFile(mixed $vars[, mixed $rebuild = false ]) : mixed
Parameters
- $vars : mixed
- $rebuild : mixed = false
fixModSecurity()
fixModSecurity() : mixed
template_install_above()
template_install_above() : mixed
template_install_below()
template_install_below() : mixed
template_welcome_message()
template_welcome_message() : mixed
template_warning_divs()
template_warning_divs() : mixed
template_chmod_files()
template_chmod_files() : mixed
template_database_settings()
template_database_settings() : mixed
template_forum_settings()
template_forum_settings() : mixed
template_populate_database()
template_populate_database() : mixed
template_admin_account()
template_admin_account() : mixed
template_delete_install()
template_delete_install() : mixed
upgrade_clean_cache()
Clean the cache using the SMF 2.1 CacheAPI.
upgrade_clean_cache() : mixed
If coming from SMF 2.0 and below it should wipe the cache using the SMF backend.
getMemberGroups()
Returns a list of member groups. Used to upgrade 1.0 and 1.1.
getMemberGroups() : array<string|int, mixed>
Return values
array<string|int, mixed>makeFilesWritable()
Make files writable. First try to use regular chmod, but if that fails, try to use FTP.
makeFilesWritable( &$files) : bool
Parameters
Return values
boolquickFileWritable()
The quick version of makeFilesWritable, which does not support FTP.
quickFileWritable(string $file) : bool
Parameters
- $file : string
Return values
booldeleteFile()
Delete a file. Check permissions first, just in case.
deleteFile(string $file) : mixed
Parameters
- $file : string
print_error()
Prints an error to stderr.
print_error( $message[, bool $fatal = false ]) : mixed
Parameters
throw_error()
Throws a graphical error message.
throw_error( $message) : bool
Parameters
Return values
boolsmf_mysql_fetch_assoc()
smf_mysql_fetch_assoc( $rs) : array<string|int, mixed>|null
Parameters
Return values
array<string|int, mixed>|nullsmf_mysql_fetch_row()
smf_mysql_fetch_row( $rs) : array<string|int, mixed>|null
Parameters
Return values
array<string|int, mixed>|nullsmf_mysql_free_result()
smf_mysql_free_result( $rs) : mixed
Parameters
smf_mysql_insert_id()
smf_mysql_insert_id([ $rs = null ]) : int|string
Parameters
Return values
int|stringsmf_mysql_num_rows()
smf_mysql_num_rows( $rs) : int
Parameters
Return values
intsmf_mysql_real_escape_string()
smf_mysql_real_escape_string( $string) : mixed
Parameters
array_column()
array_column(mixed $input, mixed $column_key[, mixed $index_key = null ]) : mixed
Parameters
- $input : mixed
- $column_key : mixed
- $index_key : mixed = null
upgradeCacheSettings()
Creates the json_encoded array for the current cache option.
upgradeCacheSettings() : string
Return values
string —a json_encoded array with the selected API options
upgradeExit()
upgradeExit([mixed $fallThrough = false ]) : mixed
Parameters
- $fallThrough : mixed = false
findSettingsFile()
findSettingsFile() : mixed
load_lang_file()
load_lang_file() : mixed
redirectLocation()
redirectLocation(mixed $location[, mixed $addForm = true ]) : mixed
Parameters
- $location : mixed
- $addForm : mixed = true
loadEssentialData()
loadEssentialData() : mixed
initialize_inputs()
initialize_inputs() : mixed
WelcomeLogin()
WelcomeLogin() : mixed
checkFolders()
checkFolders() : mixed
checkLogin()
checkLogin() : mixed
UpgradeOptions()
UpgradeOptions() : mixed
BackupDatabase()
BackupDatabase() : mixed
backupTable()
backupTable(mixed $table) : mixed
Parameters
- $table : mixed
DatabaseChanges()
DatabaseChanges() : mixed
setSqlMode()
setSqlMode([mixed $strict = true ]) : mixed
Parameters
- $strict : mixed = true
DeleteUpgrade()
DeleteUpgrade() : mixed
cli_scheduled_fetchSMfiles()
cli_scheduled_fetchSMfiles() : mixed
convertSettingsToTheme()
convertSettingsToTheme() : mixed
convertSettingstoOptions()
convertSettingstoOptions() : mixed
php_version_check()
php_version_check() : mixed
db_version_check()
db_version_check() : mixed
fixRelativePath()
fixRelativePath(mixed $path) : mixed
Parameters
- $path : mixed
parse_sql()
parse_sql(mixed $filename) : mixed
Parameters
- $filename : mixed
upgrade_query()
upgrade_query(mixed $string[, mixed $unbuffered = false ]) : mixed
Parameters
- $string : mixed
- $unbuffered : mixed = false
protected_alter()
protected_alter(mixed $change, mixed $substep[, mixed $is_test = false ]) : mixed
Parameters
- $change : mixed
- $substep : mixed
- $is_test : mixed = false
textfield_alter()
Alter a text column definition preserving its character set.
textfield_alter(array<string|int, mixed> $change, int $substep) : mixed
Parameters
- $change : array<string|int, mixed>
- $substep : int
nextSubstep()
nextSubstep(mixed $substep) : mixed
Parameters
- $substep : mixed
cmdStep0()
cmdStep0() : mixed
ConvertUtf8()
Handles converting your database to UTF-8
ConvertUtf8() : mixed
upgrade_unserialize()
Wrapper for unserialize that attempts to repair corrupted serialized data strings
upgrade_unserialize(string $string) : string|bool
Parameters
- $string : string
-
Serialized data that may or may not have been corrupted
Return values
string|bool —The unserialized data, or false if the repair failed
serialize_to_json()
serialize_to_json() : mixed
template_chmod()
template_chmod() : mixed
template_upgrade_above()
template_upgrade_above() : mixed
template_upgrade_below()
template_upgrade_below() : mixed
template_xml_above()
template_xml_above() : mixed
template_xml_below()
template_xml_below() : mixed
template_error_message()
template_error_message() : mixed
template_welcome_message()
template_welcome_message() : mixed
template_upgrade_options()
template_upgrade_options() : mixed
template_backup_database()
template_backup_database() : mixed
template_backup_xml()
template_backup_xml() : mixed
template_database_changes()
template_database_changes() : mixed
template_database_xml()
template_database_xml() : mixed
template_convert_utf8()
template_convert_utf8() : mixed
template_convert_xml()
template_convert_xml() : mixed
template_serialize_json()
template_serialize_json() : mixed
template_serialize_json_xml()
template_serialize_json_xml() : mixed
template_upgrade_complete()
template_upgrade_complete() : mixed
MySQLConvertOldIp()
Convert MySQL (var)char ip col to binary
MySQLConvertOldIp(string $targetTable, string $oldCol, string $newCol[, int $limit = 50000 ][, int $setSize = 100 ]) : bool
newCol needs to be a varbinary(16) null able field
Parameters
- $targetTable : string
-
The table to perform the operation on
- $oldCol : string
-
The old column to gather data from
- $newCol : string
-
The new column to put data in
- $limit : int = 50000
-
The amount of entries to handle at once.
- $setSize : int = 100
-
The amount of entries after which to update the database.
Return values
boolupgradeGetColumnInfo()
Get the column info. This is basically the same as smf_db_list_columns but we get 1 column, force detail and other checks.
upgradeGetColumnInfo(string $targetTable, string $column) : array<string|int, mixed>
Parameters
- $targetTable : string
-
The table to perform the operation on
- $column : string
-
The column we are looking for.
Return values
array<string|int, mixed> —Info on the table.
smf_crc32()
Compatibility function.
smf_crc32(string $number) : string
crc32 doesn't work as expected on 64-bit functions - make our own. https://php.net/crc32#79567
Parameters
- $number : string
Return values
string —The crc32 polynomial of $number
idn_to_ascii()
Compatibility function.
idn_to_ascii(string $domain[, int $flags = 0 ][, int $variant = 1 ][, array<string|int, mixed>|null &$idna_info = null ]) : string|bool
This is not a complete polyfill:
- $flags only supports IDNA_DEFAULT, IDNA_NONTRANSITIONAL_TO_ASCII, and IDNA_USE_STD3_RULES.
- $variant is ignored, because INTL_IDNA_VARIANT_UTS46 is always used.
- $idna_info is ignored.
Parameters
- $domain : string
-
The domain to convert, which must be UTF-8 encoded.
- $flags : int = 0
-
A subset of possible IDNA_* flags.
- $variant : int = 1
-
Ignored in this compatibility function.
- $idna_info : array<string|int, mixed>|null = null
-
Ignored in this compatibility function.
Return values
string|bool —The domain name encoded in ASCII-compatible form, or false on failure.
idn_to_utf8()
Compatibility function.
idn_to_utf8(string $domain[, int $flags = 0 ][, int $variant = 1 ][, array<string|int, mixed>|null &$idna_info = null ]) : string|bool
This is not a complete polyfill:
- $flags only supports IDNA_DEFAULT, IDNA_NONTRANSITIONAL_TO_UNICODE, and IDNA_USE_STD3_RULES.
- $variant is ignored, because INTL_IDNA_VARIANT_UTS46 is always used.
- $idna_info is ignored.
Parameters
- $domain : string
-
Domain to convert, in an IDNA ASCII-compatible format.
- $flags : int = 0
-
Ignored in this compatibility function.
- $variant : int = 1
-
Ignored in this compatibility function.
- $idna_info : array<string|int, mixed>|null = null
-
Ignored in this compatibility function.
Return values
string|bool —The domain name in Unicode, encoded in UTF-8, or false on failure.
template_ssi_above()
Displays the header for this file
template_ssi_above() : mixed
template_ssi_below()
Displays the footer for this file
template_ssi_below() : mixed
template_homepage_sample1()
Displays a sample homepage to give you an idea of what's possible using SSI functions
template_homepage_sample1([string $method = 'source' ]) : string|void
Parameters
- $method : string = 'source'
-
If 'source', simply returns the source code, otherwise displays it
Return values
string|void —Returns the HTML source if $method is 'source', otherwise displays it
template_homepage_sample1_php()
Generates the sample homepage. Used with template_homepage_sample1 if $method isn't 'source'.
template_homepage_sample1_php() : mixed
template_homepage_sample1_html()
Generates the HTML for the homepage sample. Used in conjunction with template_homepage_sample1 if method is 'source'
template_homepage_sample1_html() : string
Return values
string —The HTML code for the sample homepage
generateSubscriptionError()
Log an error then exit
generateSubscriptionError(string $text[, bool $debug = false ]) : mixed
Parameters
- $text : string
-
The error to log
- $debug : bool = false
-
If true, won't send an email if Config::$modSettings['paid_email'] isn't set
template_admin()
This is the administration center home.
template_admin() : mixed
template_credits()
Show some support information and credits to those who helped make this.
template_credits() : mixed
template_view_versions()
Displays information about file versions installed, and compares them to current version.
template_view_versions() : mixed
template_edit_censored()
Form for stopping people using naughty words, etc.
template_edit_censored() : mixed
template_not_done()
This is the page shown when we've temporarily paused things such as during maintenance tasks, sending newsletters, etc.
template_not_done() : mixed
template_show_settings()
Template for showing settings (Of any kind really!)
template_show_settings() : mixed
template_show_custom_profile()
Template for showing custom profile fields.
template_show_custom_profile() : mixed
template_edit_profile_field()
Template for editing a custom profile field
template_edit_profile_field() : mixed
template_admin_search_results()
Results page for an admin search.
template_admin_search_results() : mixed
template_callback_question_answer_list()
This little beauty shows questions and answer from the captcha type feature.
template_callback_question_answer_list() : mixed
template_repair_boards()
Repairing boards.
template_repair_boards() : mixed
template_php_info()
Retrieves info from the php_info function, scrubs and preps it for display
template_php_info() : mixed
template_clean_cache_button_above()
Content shown above the clean cache button
template_clean_cache_button_above() : mixed
template_clean_cache_button_below()
Content shown below the clean cache button?
template_clean_cache_button_below() : mixed
template_admin_quick_search()
This shows the admin search form
template_admin_quick_search() : mixed
template_main()
template_main() : mixed
template_boardindex_outer_above()
The top part of the outer layer of the boardindex
template_boardindex_outer_above() : mixed
template_newsfader()
This shows the newsfader
template_newsfader() : mixed
template_main()
This actually displays the board index
template_main() : mixed
template_bi_board_icon()
Outputs the board icon for a standard board.
template_bi_board_icon(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_redirect_icon()
Outputs the board icon for a redirect.
template_bi_redirect_icon(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_board_info()
Outputs the board info for a standard board or redirect.
template_bi_board_info(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_board_stats()
Outputs the board stats for a standard board.
template_bi_board_stats(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_redirect_stats()
Outputs the board stats for a redirect.
template_bi_redirect_stats(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_board_lastpost()
Outputs the board lastposts for a standard board or a redirect.
template_bi_board_lastpost(array<string|int, mixed> $board) : mixed
When on a mobile device, this may be hidden if no last post exists.
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_board_children()
Outputs the board children for a standard board.
template_bi_board_children(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_boardindex_outer_below()
The lower part of the outer layer of the board index
template_boardindex_outer_below() : mixed
template_info_center()
Displays the info center
template_info_center() : mixed
template_ic_block_recent()
The recent posts section of the info center
template_ic_block_recent() : mixed
template_ic_block_calendar()
The calendar section of the info center
template_ic_block_calendar() : mixed
template_ic_block_stats()
The stats section of the info center
template_ic_block_stats() : mixed
template_ic_block_online()
The who's online section of the info center
template_ic_block_online() : mixed
template_main()
Our main calendar template, which encapsulates weeks and months.
template_main() : mixed
template_show_upcoming_list()
Display a list of upcoming events, birthdays, and holidays.
template_show_upcoming_list(string $grid_name) : void|bool
Parameters
- $grid_name : string
-
The grid name
Return values
void|bool —Returns false if the grid doesn't exist.
template_show_month_grid()
Display a monthly calendar grid.
template_show_month_grid(string $grid_name[, bool $is_mini = false ]) : void|bool
Parameters
- $grid_name : string
-
The grid name
- $is_mini : bool = false
-
Is this a mini grid?
Return values
void|bool —Returns false if the grid doesn't exist.
template_show_week_grid()
Shows a weekly grid
template_show_week_grid(string $grid_name) : void|bool
Parameters
- $grid_name : string
-
The name of the grid
Return values
void|bool —Returns false if the grid doesn't exist
template_calendar_top()
Calendar controls under the title
template_calendar_top(array<string|int, mixed> $calendar_data) : mixed
Creates the view selector (list, month, week), the date selector (either a select menu or a date range chooser, depending on the circumstances), and the "Post Event" button.
Parameters
- $calendar_data : array<string|int, mixed>
-
The data for the calendar grid that this is for
template_event_post()
Template for posting a calendar event.
template_event_post() : mixed
template_bcd()
Displays a clock
template_bcd() : mixed
template_hms()
Displays the hours, minutes and seconds for our clock
template_hms() : mixed
template_omfg()
Displays a binary clock
template_omfg() : mixed
template_thetime()
Displays the time
template_thetime() : mixed
template_main()
This template handles displaying a topic
template_main() : mixed
template_single_post()
Template for displaying a single post.
template_single_post(array<string|int, mixed> $message) : mixed
Parameters
- $message : array<string|int, mixed>
-
An array of information about the message to display. Should have 'id' and 'member'. Can also have 'first_new', 'is_ignored' and 'css_class'.
template_quickreply()
The template for displaying the quick reply box.
template_quickreply() : mixed
template_fatal_error()
THis displays a fatal error message
template_fatal_error() : mixed
template_error_log()
This template handles the error log in the admin center.
template_error_log() : mixed
template_show_file()
This template shows a snippet of code from a file and highlights which line caused the error.
template_show_file() : mixed
template_attachment_errors()
This template handles showing attachment-related errors
template_attachment_errors() : mixed
template_show_backtrace()
This template shows a backtrace of the given error
template_show_backtrace() : mixed
template_control_richedit()
This function displays all the stuff you get with a richedit box - BBC, smileys, etc.
template_control_richedit(string $editor_id[, null|bool $smileyContainer = null ][, null|bool $bbcContainer = null ]) : mixed
Parameters
- $editor_id : string
-
The editor ID
- $smileyContainer : null|bool = null
-
If null, hides the smiley section regardless of settings
- $bbcContainer : null|bool = null
-
If null, hides the bbcode buttons regardless of settings
template_control_richedit_buttons()
This template shows the form buttons at the bottom of the editor
template_control_richedit_buttons(string $editor_id) : mixed
Parameters
- $editor_id : string
-
The editor ID
template_control_verification()
This template displays a verification form
template_control_verification(int|string $verify_id[, string $display_type = 'all' ][, bool $reset = false ]) : bool
Parameters
- $verify_id : int|string
-
The verification control ID
- $display_type : string = 'all'
-
What type to display. Can be 'single' to only show one verification option or 'all' to show all of them
- $reset : bool = false
-
Whether to reset the internal tracking counter
Return values
bool —False if there's nothing else to show, true if $display_type is 'single', nothing otherwise
template_show_list()
This template handles displaying a list
template_show_list([string $list_id = null ]) : mixed
Parameters
- $list_id : string = null
-
The list ID. If null, uses Utils::$context['default_list'].
template_additional_rows()
This template displays additional rows above or below the list.
template_additional_rows(string $row_position, array<string|int, mixed> $cur_list) : mixed
Parameters
- $row_position : string
-
The position ('top', 'bottom', etc.)
- $cur_list : array<string|int, mixed>
-
An array with the data for the current list
template_generic_menu_dropdown_above()
This contains the HTML for the menu bar at the top of the admin center.
template_generic_menu_dropdown_above() : mixed
template_generic_menu_dropdown_below()
Part of the admin layer - used with generic_menu_dropdown_above to close the admin content div.
template_generic_menu_dropdown_below() : mixed
template_generic_menu()
The template for displaying a menu
template_generic_menu(array<string|int, mixed> &$menu_context) : mixed
Parameters
- $menu_context : array<string|int, mixed>
-
An array of menu information
template_generic_menu_tabs()
The code for displaying the menu
template_generic_menu_tabs(array<string|int, mixed> &$menu_context) : mixed
Parameters
- $menu_context : array<string|int, mixed>
-
An array of menu context data
template_popup()
This displays a help popup thingy
template_popup() : mixed
template_find_members()
The template for the popup for finding members
template_find_members() : mixed
template_manual()
The main help page
template_manual() : mixed
template_init()
Initialize the template... mainly little settings.
template_init() : mixed
template_html_above()
The main sub template above the content.
template_html_above() : mixed
template_body_above()
The upper part of the main template layer. This is the stuff that shows above the main forum content.
template_body_above() : mixed
template_body_below()
The stuff shown immediately below the main content, including the footer
template_body_below() : mixed
template_html_below()
This shows any deferred JavaScript and closes out the HTML
template_html_below() : mixed
theme_linktree()
Show a linktree. This is that thing that shows "My Community | General Category | General Discussion".
theme_linktree([bool $force_show = false ]) : mixed
.
Parameters
- $force_show : bool = false
-
Whether to force showing it even if settings say otherwise
template_menu()
Show the menu up top. Something like [home] [help] [profile] [logout].
template_menu() : mixed
..
template_button_strip()
Generate a strip of buttons.
template_button_strip(array<string|int, mixed> $button_strip[, string $direction = '' ][, array<string|int, mixed> $strip_options = array() ]) : mixed
Parameters
- $button_strip : array<string|int, mixed>
-
An array with info for displaying the strip
- $direction : string = ''
-
The direction
- $strip_options : array<string|int, mixed> = array()
-
Options for the button strip
template_quickbuttons()
Generate a list of quickbuttons.
template_quickbuttons(array<string|int, mixed> $list_items[, string $list_class = null ][, string $output_method = 'echo' ]) : void|string
Parameters
- $list_items : array<string|int, mixed>
-
An array with info for displaying the strip
- $list_class : string = null
-
Used for integration hooks and as a class name
- $output_method : string = 'echo'
-
The output method. If 'echo', simply displays the buttons, otherwise returns the HTML for them
Return values
void|string —Returns nothing unless output_method is something other than 'echo'
template_maint_warning_above()
The upper part of the maintenance warning box
template_maint_warning_above() : mixed
template_maint_warning_below()
The lower part of the maintenance warning box.
template_maint_warning_below() : mixed
template_popup()
This shows the popup that shows who likes a particular post.
template_popup() : mixed
template_like()
Display a like button and info about how many people liked something
template_like() : mixed
template_generic()
A generic template that outputs any data passed to it.
template_generic() : mixed
..
template_login()
This is just the basic "login" form.
template_login() : mixed
template_login_tfa()
TFA authentication form
template_login_tfa() : mixed
template_kick_guest()
Tell a guest to get lost or login!
template_kick_guest() : mixed
template_maintenance()
This is for maintenance mode.
template_maintenance() : mixed
template_admin_login()
This is for the security stuff - makes administrators login every so often.
template_admin_login() : mixed
template_retry_activate()
Activate your account manually?
template_retry_activate() : mixed
template_resend()
The form for resending the activation code.
template_resend() : mixed
template_logout()
Confirm a logout.
template_logout() : mixed
template_avatar_settings_above()
This template wraps around the simple settings page to add javascript functionality.
template_avatar_settings_above() : mixed
template_avatar_settings_below()
JavaScript to be output below the simple settings page
template_avatar_settings_below() : mixed
template_maintenance()
The attachment maintenance page
template_maintenance() : mixed
template_attachment_repair()
The file repair page
template_attachment_repair() : mixed
template_attachment_paths()
The page that handles managing attachment paths.
template_attachment_paths() : mixed
template_ban_edit()
Add or edit a ban
template_ban_edit() : mixed
template_ban_edit_trigger()
Add or edit a ban trigger
template_ban_edit_trigger() : mixed
template_main()
Template for listing all the current categories and boards.
template_main() : mixed
template_modify_category()
Template for editing/adding a category on the forum.
template_modify_category() : mixed
template_confirm_category_delete()
A template to confirm if a user wishes to delete a category - and whether they want to save the boards.
template_confirm_category_delete() : mixed
template_modify_board()
Below is the template for adding/editing a board on the forum.
template_modify_board() : mixed
template_confirm_board_delete()
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_confirm_board_delete() : mixed
template_edit_holiday()
Editing or adding holidays.
template_edit_holiday() : mixed
template_download_language()
Download a new language file.
template_download_language() : mixed
template_modify_language_entries()
Edit language entries. Note that this doesn't always work because of PHP's max_post_vars setting.
template_modify_language_entries() : mixed
template_add_language()
Add a new language
template_add_language() : mixed
template_browse()
Template for browsing the mail queue.
template_browse() : mixed
template_mailtest()
Template for testing mail send.
template_mailtest() : mixed
template_maintain_database()
Template for the database maintenance tasks.
template_maintain_database() : mixed
template_maintain_routine()
Template for the routine maintenance tasks.
template_maintain_routine() : mixed
template_maintain_members()
Template for the member maintenance tasks.
template_maintain_members() : mixed
template_maintain_topics()
Template for the topic maintenance tasks.
template_maintain_topics() : mixed
template_optimize()
Simple template for showing results of our optimization.
template_optimize() : mixed
..
template_convert_entities()
Template for converting entities to UTF-8 characters
template_convert_entities() : mixed
template_convert_msgbody()
Template for converting posts to UTF-8.
template_convert_msgbody() : mixed
template_main()
The main page listing all the groups.
template_main() : mixed
template_new_group()
Add a new membergroup.
template_new_group() : mixed
template_edit_group()
Edit an existing membergroup.
template_edit_group() : mixed
template_add_edit_group_boards_list()
The template for determining which boards a group has access to.
template_add_edit_group_boards_list([bool $collapse = true ][, mixed $form_id = 'new_group' ]) : mixed
Parameters
- $collapse : bool = true
-
Whether to collapse the list by default
- $form_id : mixed = 'new_group'
template_group_members()
Template for viewing the members of a group.
template_group_members() : mixed
template_group_request_reason()
Allow the moderator to enter a reason to each user being rejected.
template_group_request_reason() : mixed
template_search_members()
The admin member search form
template_search_members() : mixed
template_admin_browse()
The admin member list.
template_admin_browse() : mixed
template_email_members()
The template for sending newsletters
template_email_members() : mixed
template_email_members_compose()
The form for composing a newsletter
template_email_members_compose() : mixed
template_email_members_send()
The page shown while the newsletter is being sent
template_email_members_send() : mixed
template_news_lists()
The settings page.
template_news_lists() : mixed
template_modify_subscription()
The template for adding or editing a subscription.
template_modify_subscription() : mixed
template_delete_subscription()
The page for deleting a subscription.
template_delete_subscription() : mixed
template_modify_user_subscription()
Add or edit an existing subscriber.
template_modify_user_subscription() : mixed
template_user_subscription()
Template for a user to edit/pick their subscriptions.
template_user_subscription() : mixed
template_choose_payment()
The "choose payment" dialog.
template_choose_payment() : mixed
template_paid_done()
The "thank you" bit.
template_paid_done() : mixed
..
template_permission_index()
The main manage permissions page
template_permission_index() : mixed
template_by_board()
THe page that shows which permissions profile applies to each board
template_by_board() : mixed
template_edit_profiles()
Edit permission profiles (predefined).
template_edit_profiles() : mixed
template_modify_group()
Modify a group's permissions
template_modify_group() : mixed
template_modify_group_display()
The way of looking at permissions.
template_modify_group_display(string $type) : mixed
Parameters
- $type : string
-
The permissions type
template_inline_permissions()
A form for displaying inline permissions, such as on a settings page.
template_inline_permissions() : mixed
template_postmod_permissions()
Edit post moderation permissions.
template_postmod_permissions() : mixed
template_view_scheduled_tasks()
Template for listing all scheduled tasks.
template_view_scheduled_tasks() : mixed
template_edit_scheduled_tasks()
A template for, you guessed it, editing a task!
template_edit_scheduled_tasks() : mixed
template_modify_weights()
Modify the search weights.
template_modify_weights() : mixed
template_select_search_method()
Select the search method.
template_select_search_method() : mixed
template_create_index()
Create a search index.
template_create_index() : mixed
template_create_index_progress()
Display a progress page while creating a search index.
template_create_index_progress() : mixed
template_create_index_done()
Done creating a search index.
template_create_index_done() : mixed
template_spider_edit()
Add or edit a search engine spider.
template_spider_edit() : mixed
template_show_spider_logs()
Show... spider... logs.
template_show_spider_logs() : mixed
..
template_show_spider_stats()
Show... spider... stats.
template_show_spider_stats() : mixed
..
template_editsets()
Shows a list of smiley sets so you can edit them.
template_editsets() : mixed
template_modifyset()
Modifying a smiley set.
template_modifyset() : mixed
template_modifysmiley()
Editing an individual smiley
template_modifysmiley() : mixed
template_addsmiley()
Adding a new smiley.
template_addsmiley() : mixed
template_setorder()
Ordering smileys.
template_setorder() : mixed
template_editicons()
Editing Message Icons
template_editicons() : mixed
template_editicon()
Editing an individual message icon
template_editicon() : mixed
template_main()
Displays a sortable listing of all members registered on the forum.
template_main() : mixed
template_search()
A page allowing people to search the member list.
template_search() : mixed
template_main()
The main messageindex.
template_main() : mixed
template_bi_board_icon()
Outputs the board icon for a standard board.
template_bi_board_icon(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_redirect_icon()
Outputs the board icon for a redirect.
template_bi_redirect_icon(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_board_info()
Outputs the board info for a standard board or redirect.
template_bi_board_info(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_board_stats()
Outputs the board stats for a standard board.
template_bi_board_stats(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_redirect_stats()
Outputs the board stats for a redirect.
template_bi_redirect_stats(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_board_lastpost()
Outputs the board lastposts for a standard board or a redirect.
template_bi_board_lastpost(array<string|int, mixed> $board) : mixed
When on a mobile device, this may be hidden if no last post exists.
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_bi_board_children()
Outputs the board children for a standard board.
template_bi_board_children(array<string|int, mixed> $board) : mixed
Parameters
- $board : array<string|int, mixed>
-
Current board information.
template_topic_legend()
Shows a legend for topic icons.
template_topic_legend() : mixed
template_moderation_center()
The main moderation center.
template_moderation_center() : mixed
template_group_requests_block()
Show all the group requests the user can see.
template_group_requests_block() : mixed
template_watched_users()
A list of watched users
template_watched_users() : mixed
template_reported_posts_block()
A list of reported posts
template_reported_posts_block() : mixed
template_reported_users_block()
A list of reported users
template_reported_users_block() : mixed
template_notes()
Little section for making... notes.
template_notes() : mixed
template_unapproved_posts()
Show a list of all the unapproved posts
template_unapproved_posts() : mixed
template_user_watch_post_callback()
Callback function for showing a watched users post in the table.
template_user_watch_post_callback(array<string|int, mixed> $post) : string
Parameters
- $post : array<string|int, mixed>
-
An array of data about the post.
Return values
string —An array of HTML for showing the post info.
template_moderation_settings()
The moderation settings page.
template_moderation_settings() : mixed
template_show_notice()
Show a notice sent to a user.
template_show_notice() : mixed
template_warn_template()
Add or edit a warning template.
template_warn_template() : mixed
template_move()
Show an interface for selecting which board to move a post to.
template_move() : mixed
template_redirect_options()
Redirection topic options
template_redirect_options(string $type) : mixed
Parameters
- $type : string
-
What type of topic this is for - currently 'merge' or 'move'. Used to display appropriate text strings...
template_merge_done()
Confirmation page shown when finished merging topics.
template_merge_done() : mixed
template_merge()
Merge topic page.
template_merge() : mixed
template_merge_extra_options()
Extra options related to merging topics.
template_merge_extra_options() : mixed
template_main()
The main notification bar.
template_main() : mixed
template_notify_board()
Board notification bar.
template_notify_board() : mixed
template_notify_announcements()
template_notify_announcements() : mixed
template_notify_pref_changed()
Displays a message indicating the user's notification preferences were successfully changed
template_notify_pref_changed() : mixed
template_main()
The main template
template_main() : mixed
template_view_package()
View package details when installing/uninstalling
template_view_package() : mixed
template_extract_package()
Extract package contents
template_extract_package() : mixed
template_list()
List files in a package
template_list() : mixed
template_examine()
Examine a single file within a package
template_examine() : mixed
template_browse()
List all packages
template_browse() : mixed
template_servers()
List package servers
template_servers() : mixed
template_package_confirm()
Confirm package operation
template_package_confirm() : mixed
template_package_list()
List packages.
template_package_list() : mixed
template_downloaded()
Confirmation page showing a package was uploaded/downloaded successfully.
template_downloaded() : mixed
template_install_options()
Installation options - FTP info and backup settings
template_install_options() : mixed
template_control_chmod()
CHMOD control form
template_control_chmod() : bool
Return values
bool —False if nothing to do.
template_ftp_required()
Wrapper for the above template function showing that FTP is required
template_ftp_required() : mixed
template_view_operations()
View operation details.
template_view_operations() : mixed
template_file_permissions()
The file permissions page.
template_file_permissions() : mixed
template_permission_show_contents()
Shows permissions for items within a directory (called from template_file_permissions)
template_permission_show_contents(string $ident, array<string|int, mixed> $contents, int $level[, bool $has_more = false ]) : mixed
Parameters
- $ident : string
-
A unique ID - typically the directory name
- $contents : array<string|int, mixed>
-
An array of items within the directory
- $level : int
-
How far to go inside the directory
- $has_more : bool = false
-
Whether there are more files to display besides what's in $contents
template_action_permissions()
A progress page showing what permissions changes are being applied
template_action_permissions() : mixed
template_pm_above()
This is for stuff above the menu in the personal messages section
template_pm_above() : mixed
template_pm_below()
Just the end of the index bar, nothing special.
template_pm_below() : mixed
template_pm_popup()
Displays a popup with information about your personal messages
template_pm_popup() : mixed
template_folder()
Shows a particular folder (eg inbox or outbox), all the PMs in it, etc.
template_folder() : mixed
template_single_pm()
Template for displaying a single personal message.
template_single_pm(array<string|int, mixed> $message) : mixed
Parameters
- $message : array<string|int, mixed>
-
An array of information about the message to display.
template_subject_list()
Just list all the personal message subjects - to make templates easier.
template_subject_list() : mixed
template_search()
The form for the PM search feature
template_search() : mixed
template_search_results()
Displays results from a PM search
template_search_results() : mixed
template_send()
The form for sending a new PM
template_send() : mixed
template_ask_delete()
This template asks the user whether they wish to empty out their folder/messages.
template_ask_delete() : mixed
template_prune()
This template asks the user what messages they want to prune.
template_prune() : mixed
template_labels()
Here we allow the user to setup labels, remove labels and change rules for labels (i.e, do quite a bit)
template_labels() : mixed
template_report_message()
Template for reporting a personal message.
template_report_message() : mixed
template_report_message_complete()
Little template just to say "Yep, it's been submitted"
template_report_message_complete() : mixed
template_rules()
Manage rules.
template_rules() : mixed
template_add_rule()
Template for adding/editing a rule.
template_add_rule() : mixed
template_showPMDrafts()
Template for showing all of a user's PM drafts.
template_showPMDrafts() : mixed
template_main()
A form for creating and/or editing a poll.
template_main() : mixed
template_main()
The main template for the post page.
template_main() : mixed
template_spellcheck()
The template for the spellchecker.
template_spellcheck() : mixed
template_quotefast()
The template for the AJAX quote feature
template_quotefast() : mixed
template_announce()
The form for sending out an announcement
template_announce() : mixed
template_announcement_send()
The confirmation/progress page, displayed after the admin has clicked the button to send the announcement.
template_announcement_send() : mixed
template_post_header()
Prints the input fields in the form's header (subject, message icon, guest name & email, etc.)
template_post_header() : mixed
Mod authors can use the 'integrate_post_end' hook to modify or add to these (see Post.php).
Theme authors can customize the output in a couple different ways:
- Change specific values in the Utils::$context['posting_fields'] array.
- Add an 'html' element to the 'label' and/or 'input' elements of the field they want to change. This should contain the literal HTML string to be printed.
See the documentation in Post.php for more info on the Utils::$context['posting_fields'] array.
template_print_above()
The header. Defines the look and layout of the page as well as a form for choosing print options.
template_print_above() : mixed
template_main()
The main page. This shows the relevant info in a printer-friendly format
template_main() : mixed
template_print_below()
The footer.
template_print_below() : mixed
template_print_options()
Displays the print page options
template_print_options() : mixed
template_profile_above()
Minor stuff shown above the main profile - mostly used for error messages and showing that the profile update was successful.
template_profile_above() : mixed
template_profile_below()
Template for any HTML needed below the profile (closing off divs/tables, etc.)
template_profile_below() : mixed
template_profile_popup()
Template for showing off the spiffy popup of the menu
template_profile_popup() : mixed
template_alerts_popup()
The "popup" showing the user's alerts
template_alerts_popup() : mixed
template_alerts_all_read()
A simple template to say "You don't have any unread alerts".
template_alerts_all_read() : mixed
template_summary()
This template displays a user's details without any option to edit them.
template_summary() : mixed
template_showPosts()
Template for showing all the posts of the user, in chronological order.
template_showPosts() : mixed
template_showAlerts()
Template for showing all alerts
template_showAlerts() : mixed
template_showDrafts()
Template for showing all of a user's drafts
template_showDrafts() : mixed
template_editBuddies()
Template for showing and managing the buddy list.
template_editBuddies() : mixed
template_editIgnoreList()
Template for showing the ignore list of the current user.
template_editIgnoreList() : mixed
template_trackActivity()
This template shows an admin information on a users IP addresses used and errors attributed to them.
template_trackActivity() : mixed
template_trackIP()
The template for trackIP, allowing the admin to see where/who a certain IP has been used.
template_trackIP() : mixed
template_showPermissions()
This template shows an admin which permissions a user have and which group(s) give them each permission.
template_showPermissions() : mixed
template_statPanel()
Template for user statistics, showing graphs and the like.
template_statPanel() : mixed
template_edit_options()
Template for editing profile options.
template_edit_options() : mixed
template_profile_pm_settings()
Personal Message settings.
template_profile_pm_settings() : mixed
template_profile_theme_settings()
Template for showing theme settings. Note: template_options() actually adds the theme specific options.
template_profile_theme_settings() : mixed
template_alert_configuration()
The template for configuring alerts
template_alert_configuration() : mixed
template_alert_notifications_topics()
Template for showing which topics you're subscribed to
template_alert_notifications_topics() : mixed
template_alert_notifications_boards()
Template for showing which boards you're subscribed to
template_alert_notifications_boards() : mixed
template_groupMembership()
Template for choosing group membership.
template_groupMembership() : mixed
template_ignoreboards()
Template for managing ignored boards
template_ignoreboards() : mixed
template_load_warning_variables()
Simply loads some theme variables common to several warning templates.
template_load_warning_variables() : mixed
template_viewWarning()
Template for viewing a user's warnings
template_viewWarning() : mixed
template_issueWarning()
Template for issuing warnings
template_issueWarning() : mixed
template_deleteAccount()
Template to show for deleting a user's account - now with added delete post capability!
template_deleteAccount() : mixed
template_profile_save()
Template for the password box/save button stuck at the bottom of every profile page.
template_profile_save() : mixed
template_error_message()
Small template for showing an error message upon a save problem in the profile.
template_error_message() : mixed
template_profile_group_manage()
Display a load of drop down selectors for allowing the user to change group.
template_profile_group_manage() : mixed
template_profile_birthdate()
Callback function for entering a birthdate!
template_profile_birthdate() : mixed
template_profile_signature_modify()
Show the signature editing box?
template_profile_signature_modify() : mixed
template_profile_avatar_select()
Template for selecting an avatar
template_profile_avatar_select() : mixed
template_max_size()
This is just a really little helper to avoid duplicating code unnecessarily
template_max_size(string $type) : mixed
Parameters
- $type : string
-
The type of avatar
template_profile_timeformat_modify()
Select the time format!
template_profile_timeformat_modify() : mixed
template_profile_theme_pick()
Template for picking a theme
template_profile_theme_pick() : mixed
template_profile_smiley_pick()
Smiley set picker.
template_profile_smiley_pick() : mixed
template_tfasetup()
Template for setting up and managing Two-Factor Authentication.
template_tfasetup() : mixed
template_tfadisable()
Template for disabling two-factor authentication.
template_tfadisable() : mixed
template_tfasetup_backup()
Template for setting up 2FA backup code
template_tfasetup_backup() : mixed
template_profile_tfa()
Simple template for showing the 2FA area when editing a profile.
template_profile_tfa() : mixed
template_export_profile_data()
Template for initiating and retrieving profile data exports
template_export_profile_data() : mixed
template_recent()
Template for showing recent posts
template_recent() : mixed
template_unread()
Template for showing unread posts
template_unread() : mixed
template_replies()
Template for showing unread replies (eg new replies to topics you've posted in)
template_replies() : mixed
template_registration_agreement()
Before showing users a registration form, show them the registration agreement.
template_registration_agreement() : mixed
template_registration_form()
Before registering - get their information.
template_registration_form() : mixed
template_after()
After registration... all done ;).
template_after() : mixed
template_coppa()
Template for giving instructions about COPPA activation.
template_coppa() : mixed
template_coppa_form()
An easily printable form for giving permission to access the forum for a minor.
template_coppa_form() : mixed
template_verification_sound()
Show a window containing the spoken verification code.
template_verification_sound() : mixed
template_admin_register()
The template for the form allowing an admin to register a user from the admin center.
template_admin_register() : mixed
template_edit_agreement()
Form for editing the agreement shown for people registering to the forum.
template_edit_agreement() : mixed
template_edit_reserved_words()
Template for editing reserved words.
template_edit_reserved_words() : mixed
template_edit_privacy_policy()
template_edit_privacy_policy() : mixed
template_main()
The main "Here's how you can reset your password" page
template_main() : mixed
template_reminder_pick()
The page to pick an option - secret question/answer (if set) or email
template_reminder_pick() : mixed
template_sent()
Just a simple "We sent you an email. Click the link in it to continue." message
template_sent() : mixed
template_set_password()
Template for setting the new password
template_set_password() : mixed
template_ask()
The page that asks a user to answer their secret question
template_ask() : mixed
template_reported_posts()
Displays all reported posts.
template_reported_posts() : mixed
template_reported_posts_block()
A block to show the current top reported posts.
template_reported_posts_block() : mixed
template_viewmodreport()
Handles viewing details of and managing a specific report
template_viewmodreport() : mixed
template_edit_comment()
Template for editing a mod comment.
template_edit_comment() : mixed
template_reported_members_block()
A block to show the current top reported member profiles.
template_reported_members_block() : mixed
template_reported_members()
Lists all reported members
template_reported_members() : mixed
template_viewmemberreport()
Template for viewing and managing a specific report about a user's profile
template_viewmemberreport() : mixed
template_report_type()
Choose which type of report to run?
template_report_type() : mixed
template_main()
This is the standard template for showing reports.
template_main() : mixed
template_print_above()
Header of the print page!
template_print_above() : mixed
template_print()
The main print page
template_print() : mixed
template_print_below()
Footer of the print page.
template_print_below() : mixed
template_main()
The main "report this to the moderator" page
template_main() : mixed
template_main()
The main search form
template_main() : mixed
template_results()
The search results page.
template_results() : mixed
template_options()
This pseudo-template defines all the theme options
template_options() : mixed
template_settings()
This pseudo-template defines all the available theme settings (but not their actual values)
template_settings() : mixed
template_ask()
The form that asks how you want to split things
template_ask() : mixed
template_main()
A simple confirmation that things were split as expected, with links to the current board and the old and new topics.
template_main() : mixed
template_select()
The form for selecting which posts to split.
template_select() : mixed
template_main()
The stats page.
template_main() : mixed
template_main()
The main sub template - for theme administration.
template_main() : mixed
template_list_themes()
This lists all themes
template_list_themes() : mixed
template_reset_list()
This lets you reset themes
template_reset_list() : mixed
template_set_options()
This displays the form for setting theme options
template_set_options() : mixed
template_set_settings()
The page for setting and managing theme settings.
template_set_settings() : mixed
template_pick()
This template allows for the selection of different themes ;)
template_pick() : mixed
template_installed()
Okay, that theme was installed/updated successfully!
template_installed() : mixed
template_edit_list()
The page for editing themes.
template_edit_list() : mixed
template_copy_template()
The page allowing you to copy a template from one theme to another.
template_copy_template() : mixed
template_edit_browse()
This lets you browse a list of files in a theme so you can choose which one to edit.
template_edit_browse() : mixed
template_edit_style()
Wanna edit the stylesheet?
template_edit_style() : mixed
template_edit_template()
This edits the template.
template_edit_template() : mixed
..
template_edit_file()
This allows you to edit a file
template_edit_file() : mixed
template_main()
This handles the Who's Online page
template_main() : mixed
template_credits()
This displays a nice credits page
template_credits() : mixed
template_sendbody()
This defines the XML for sending the body of a message
template_sendbody() : mixed
template_quotefast()
This defines the XML for the AJAX quote feature
template_quotefast() : mixed
template_modifyfast()
This defines the XML for the inline edit feature
template_modifyfast() : mixed
template_modifydone()
The XML for handling things when you're done editing a post inline
template_modifydone() : mixed
template_modifytopicdone()
This handles things when editing a topic's subject from the messageindex.
template_modifytopicdone() : mixed
template_post()
The massive XML for previewing posts.
template_post() : mixed
template_pm()
All the XML for previewing a PM
template_pm() : mixed
template_warning()
The XML for previewing a warning
template_warning() : mixed
template_stats()
The XML for hiding/showing stats sections via AJAX
template_stats() : mixed
template_split()
The XML for selecting items to split
template_split() : mixed
template_button_strip()
template_button_strip(mixed $button_strip[, mixed $direction = 'top' ][, mixed $strip_options = array() ]) : mixed
Parameters
- $button_strip : mixed
- $direction : mixed = 'top'
- $strip_options : mixed = array()
template_menu()
template_menu() : mixed
theme_linktree()
theme_linktree() : mixed
template_results()
XML for search results
template_results() : mixed
template_jump_to()
The XML for the Jump To box
template_jump_to() : mixed
template_message_icons()
The XML for displaying a column of message icons and selecting one via AJAX
template_message_icons() : mixed
template_check_username()
The XML for instantly showing whether a username is valid on the registration page
template_check_username() : mixed
template_generic_xml()
This prints XML in its most generic form.
template_generic_xml() : mixed
template_generic_xml_recursive()
Recursive function for displaying generic XML data.
template_generic_xml_recursive(array<string|int, mixed> $xml_data, string $parent_ident, string $child_ident, int $level) : mixed
Parameters
- $xml_data : array<string|int, mixed>
-
An array of XML data
- $parent_ident : string
-
The parent tag
- $child_ident : string
-
The child tag
- $level : int
-
How many levels to indent the code