Overview

Namespaces

  • MatthiasMullie
    • Minify
      • Exceptions
    • PathConverter
  • None
  • ReCaptcha
    • RequestMethod
  • TOTP

Classes

  • apc_cache
  • apcu_cache
  • ApprovePost_Notify_Background
  • ApproveReply_Notify_Background
  • Attachments
  • Birthday_Notify_Background
  • browser_detector
  • Buddy_Notify_Background
  • cache_api
  • CreateAttachment_Notify_Background
  • CreatePost_Notify_Background
  • curl_fetch_web_data
  • custom_search
  • EventNew_Notify_Background
  • ftp_connection
  • fulltext_search
  • gif_color_table
  • gif_file
  • gif_file_header
  • gif_image
  • gif_image_header
  • gif_lzw_compression
  • GroupAct_Notify_Background
  • GroupReq_Notify_Background
  • Likes
  • Likes_Notify_Background
  • MemberReport_Notify_Background
  • MemberReportReply_Notify_Background
  • memcache_cache
  • memcached_cache
  • Mentions
  • MsgReport_Notify_Background
  • MsgReportReply_Notify_Background
  • paypal_display
  • paypal_payment
  • postgres_cache
  • ProxyServer
  • Punycode
  • Register_Notify_Background
  • search_api
  • SMF_BackgroundTask
  • smf_cache
  • sqlite_cache
  • standard_search
  • TypeError
  • Update_TLD_Regex
  • xcache_cache
  • xmlArray
  • zend_cache

Interfaces

  • cache_api_interface
  • search_api_interface

Exceptions

  • Error

Functions

  • _safe_serialize
  • _safe_unserialize
  • account
  • Activate
  • activateAccount
  • add_integration_function
  • addData
  • addInlineCss
  • addInlineJavaScript
  • addJavaScriptVar
  • AddLanguage
  • AddMailQueue
  • AddMembergroup
  • addMembersToGroup
  • addSeparator
  • AddSmiley
  • addSubscription
  • addTriggers
  • AdminAccount
  • AdminApprove
  • AdminBoardRecount
  • AdminEndSession
  • AdminHome
  • adminLogin
  • adminLogin_outputPostVars
  • AdminLogs
  • AdminMain
  • adminNotify
  • AdminRegister
  • AdminSearch
  • AdminSearchInternal
  • AdminSearchMember
  • AdminSearchOM
  • alert_configuration
  • alert_count
  • alert_delete
  • alert_mark
  • alert_markread
  • alert_notifications_boards
  • alert_notifications_topics
  • alert_purge
  • alerts_popup
  • AlignURLsWithSSLSetting
  • allowedTo
  • AnnouncementSelectMembergroup
  • AnnouncementSend
  • AnnounceTopic
  • ApplyRules
  • approveAllData
  • ApproveAttach
  • ApproveAttachments
  • ApproveMessage
  • approveMessages
  • approvePosts
  • approveTopics
  • array_column
  • array_length
  • assignAttachments
  • attachDirStatus
  • attachmentChecks
  • attachments_init_dir
  • automanage_attachments_by_space
  • automanage_attachments_check_directory
  • automanage_attachments_create_directory
  • AutoSuggest_Search_Member
  • AutoSuggest_Search_MemberGroups
  • AutoSuggest_Search_SMFVersions
  • AutoSuggestHandler
  • AutoTask
  • BackupDatabase
  • backupTable
  • Ban
  • BanBrowseTriggers
  • BanEdit
  • banEdit2
  • BanEditTrigger
  • BanList
  • banLoadAdditionalIPs
  • banLoadAdditionalIPsError
  • banLoadAdditionalIPsMember
  • BanLog
  • banPermissions
  • bbc_to_html
  • BoardIndex
  • BoardNotify
  • BoardPermissionsReport
  • BoardReport
  • boardsAllowedTo
  • BoardurlMatch
  • BookOfUnknown
  • BrowseFiles
  • BrowseMailQueue
  • BuddyListToggle
  • build_query_board
  • build_regex
  • buildEventDatetimes
  • cache_get_data
  • cache_getLastPosts
  • cache_getMembergroupList
  • cache_getOffsetIndependentEvents
  • cache_getRecentEvents
  • cache_put_data
  • cache_quick_get
  • CalculateNextTrigger
  • CalendarMain
  • CalendarPost
  • call_helper
  • call_integration_hook
  • canLinkEvent
  • canPickTheme
  • cdata_parse
  • censorText
  • check_cron
  • checkActivation
  • checkChange
  • checkConfirm
  • checkExistingTriggerIP
  • CheckFilesWritable
  • checkGD
  • checkImageContents
  • checkImagick
  • checkLogin
  • checkMagickWand
  • checkSession
  • checkSubmitOnce
  • clean_cache
  • cleanLangString
  • cleanRequest
  • cleanRequest_cron
  • cleanTokens
  • cleanXml
  • ClearMailQueue
  • cli_scheduled_fetchSMfiles
  • clock
  • cmdStep0
  • comma_format
  • compareVersions
  • ComposeMailing
  • consolidateSpiderStats
  • construct_query_string
  • constructPageIndex
  • ConvertEntities
  • ConvertMsgBody
  • convertSettingstoOptions
  • convertSettingsToTheme
  • ConvertUtf8
  • CoppaForm
  • CopyTemplate
  • copytree
  • countReports
  • create_button
  • create_chmod_control
  • create_control_richedit
  • create_control_verification
  • createAttachment
  • createBoard
  • createCategory
  • createList
  • createMenu
  • CreateMessageIndex
  • createPost
  • createSalvageArea
  • createThumbnail
  • createToken
  • createWaveFile
  • Credits
  • custFieldsMaxOrder
  • custMinify
  • DatabaseChanges
  • DatabasePopulation
  • DatabaseSettings
  • db_extend
  • db_extra_init
  • db_fix_prefix
  • db_packages_init
  • db_search_init
  • db_version_check
  • debugPrint
  • deleteAccount
  • deleteAccount2
  • deleteAllMinified
  • deleteBoards
  • deleteCategories
  • DeleteDraft
  • deleteErrors
  • DeleteInstall
  • DeleteMembergroup
  • deleteMembergroups
  • deleteMembers
  • DeleteMessage
  • deleteMessages
  • deleteModComment
  • deleteNotifyPrefs
  • DeleteUpgrade
  • deltree
  • Destroy
  • destroyMenu
  • detectBrowser
  • detectFulltextIndex
  • determineActions
  • Display
  • display_db_error
  • display_loadavg_error
  • display_maintenance_message
  • DisplayAdminFile
  • displayDebug
  • DisplayStats
  • DoLogin
  • Download
  • downloadAvatar
  • DownloadLanguage
  • dumpTags
  • EditAgreement
  • EditBoard
  • EditBoard2
  • EditBoardSettings
  • editBuddies
  • editBuddyIgnoreLists
  • EditCategory
  • EditCategory2
  • EditComment
  • EditCustomProfiles
  • EditHoliday
  • editIgnoreList
  • EditMembergroup
  • EditMessageIcons
  • editModComment
  • EditNews
  • EditPermissionProfiles
  • EditPoll
  • EditPoll2
  • EditSearchMethod
  • EditSearchSettings
  • EditSmileyOrder
  • EditSmileys
  • EditSmileySets
  • EditSmileySettings
  • EditSpider
  • EditTask
  • EditTheme
  • EditWeights
  • emailAdmins
  • EnableTheme
  • entity_fix__callback
  • escapestring__recursive
  • ExamineFile
  • expandIPv6
  • fatal_error
  • fatal_lang_error
  • fetch_alerts
  • fetch_task
  • fetch_web_data
  • fetchPerms__recursive
  • fetchTagAttributes
  • find_gpg
  • find_signed_off
  • find_signed_off_parents
  • findForumErrors
  • findMembers
  • findSearchAPI
  • finishTables
  • fix_possible_url
  • fix_serialized_data
  • fixchar__callback
  • fixchardb__callback
  • fixChildren
  • fixModSecurity
  • fixRelativePath
  • fixTag
  • fixTags
  • forum_time
  • forumProfile
  • ForumSettings
  • frameOptionsHeader
  • GeneralPermissionSettings
  • generateSubscriptionError
  • generateValidationCode
  • get_all_themes
  • get_current_settings
  • get_date_or_time_format
  • get_directory_tree_elements
  • get_file_listing
  • get_files_recursive
  • get_gravatar_url
  • get_hook_info_from_raw
  • get_installed_themes
  • get_integration_hooks
  • get_integration_hooks_count
  • get_integration_hooks_data
  • get_proxied_url
  • get_single_theme
  • get_theme_info
  • getAttachmentFilename
  • getAttachMsgInfo
  • getAvatars
  • getBirthdayRange
  • getBoardIndex
  • getBoardList
  • getBoardModeratorGroups
  • getBoardModerators
  • getBoardParents
  • getBoardTree
  • getCalendarGrid
  • getCalendarList
  • getCalendarWeek
  • getCommentModDetails
  • getCustFieldsMList
  • getDailyStats
  • getEventPoster
  • getEventProperties
  • getEventRange
  • getFileVersions
  • getHolidayRange
  • GetJumpTo
  • getLanguages
  • getLastPost
  • getLastPosts
  • GetMemberActivationCounts
  • getMemberData
  • getMemberGroups
  • getMembersOnlineStats
  • getMessageIcons
  • getMsgMemberID
  • getNewEventDatetimes
  • getNotifyPrefs
  • getPackageInfo
  • getRawAttachInfo
  • getReportComments
  • getReportDetails
  • getReports
  • getServerVersions
  • getTodayInfo
  • getTopic
  • getTreeOrder
  • getUserTimezone
  • getXmlMembers
  • getXmlNews
  • getXmlProfile
  • getXmlRecent
  • gif_outputAsPng
  • GroupList
  • groupMembership
  • groupMembership2
  • GroupPermissionsReport
  • GroupRequests
  • Groups
  • groupsAllowedTo
  • HandleComment
  • HandleReport
  • hash_benchmark
  • hash_length
  • hash_password
  • hash_salt
  • hash_verify_password
  • HelpIndex
  • HelpRules
  • highlight
  • highlight_php_code
  • host_from_ip
  • html_to_bbc
  • htmlspecialchars__recursive
  • htmltrim__recursive
  • https_redirect_active
  • httpsOn
  • iCalDownload
  • ignoreboards
  • imagecopyresamplebicubic
  • imagecreatefrombmp
  • imageMemoryCheck
  • ImportSmileys
  • inet_dtop
  • inet_ptod
  • initialize_inputs
  • InMaintenance
  • insertBanGroup
  • insertEvent
  • InstallCopy
  • InstallDir
  • installer_updateSettingsFile
  • installExit
  • InstallFile
  • InstallSmileySet
  • ip2range
  • iri_to_url
  • is_not_banned
  • is_not_guest
  • isAccessiblePM
  • isAllowedTo
  • isBannedEmail
  • isBrowser
  • isChildOf
  • isReservedName
  • issueWarning
  • isValidIP
  • isValidIPv6
  • JavaScriptEscape
  • JavaScriptModify
  • jeffsdatediff
  • JSMembers
  • KickGuest
  • legalise_bbc
  • list_getAttachDirs
  • list_getAttachments
  • list_getBanItems
  • list_getBanLogEntries
  • list_getBans
  • list_getBanTriggers
  • list_getBaseDirs
  • list_getBoardNotifications
  • list_getFiles
  • list_getGroupRequestCount
  • list_getGroupRequests
  • list_getGroupRequestsCount
  • list_getHolidays
  • list_getIPMessageCount
  • list_getIPMessages
  • list_getLanguages
  • list_getLanguagesList
  • list_getLoginCount
  • list_getLogins
  • list_getMailQueue
  • list_getMailQueueSize
  • list_getMembergroups
  • list_getMembers
  • list_getMessageIcons
  • list_getModLogEntries
  • list_getModLogEntryCount
  • list_getNews
  • list_getNumAttachments
  • list_getNumBanItems
  • list_getNumBanLogEntries
  • list_getNumBans
  • list_getNumBanTriggers
  • list_getNumFiles
  • list_getNumHolidays
  • list_getNumLanguages
  • list_getNumMembers
  • list_getNumSmileys
  • list_getNumSmileySets
  • list_getNumSpiderLogs
  • list_getNumSpiders
  • list_getNumSpiderStats
  • list_getNumTaskLogEntries
  • list_getNumUnapprovedAttachments
  • list_getNumUnwatched
  • list_getPackages
  • list_getProfileEditCount
  • list_getProfileEdits
  • list_getProfileFields
  • list_getProfileFieldSize
  • list_getScheduledTasks
  • list_getSmileys
  • list_getSmileySets
  • list_getSpiderLogs
  • list_getSpiders
  • list_getSpiderStats
  • list_getSubscribedUserCount
  • list_getSubscribedUsers
  • list_getTaskLogEntries
  • list_getTopicNotificationCount
  • list_getTopicNotifications
  • list_getUnapprovedAttachments
  • list_getUnwatched
  • list_getUserErrorCount
  • list_getUserErrors
  • list_getUserWarningCount
  • list_getUserWarnings
  • list_getWarningCount
  • list_getWarnings
  • list_getWarningTemplateCount
  • list_getWarningTemplates
  • list_getWatchedUserCount
  • list_getWatchedUserPosts
  • list_getWatchedUserPostsCount
  • list_getWatchedUsers
  • list_integration_hooks
  • listMembergroupMembers_Href
  • ListMessageIcons
  • listtree
  • load_database
  • load_file
  • load_lang_file
  • loadAttachmentContext
  • loadBoard
  • loadCacheAccelerator
  • loadCacheAPIs
  • loadCSSFile
  • loadCustomFields
  • loadDatabase
  • loadDatePair
  • loadDatePicker
  • loadEmailTemplate
  • loadEssentialData
  • loadEssentialThemeData
  • loadForumTests
  • loadGeneralSettingParameters
  • loadIllegalBBCHtmlGroups
  • loadIllegalGuestPermissions
  • loadIllegalPermissions
  • loadInstalledPackages
  • loadJavaScriptFile
  • loadLanguage
  • loadLocale
  • loadMemberContext
  • loadMemberCustomFields
  • loadMemberData
  • loadPaymentGateways
  • loadPermissionProfiles
  • loadPermissions
  • loadProfileFields
  • LoadRules
  • loadSearchAPIs
  • loadSession
  • loadSubscriptions
  • loadSubTemplate
  • loadTemplate
  • loadTheme
  • loadThemeOptions
  • loadTimePicker
  • loadUserSettings
  • LockTopic
  • LockVoting
  • log_ban
  • log_error
  • log_error_online
  • logAction
  • logActions
  • Login
  • Login2
  • LoginTFA
  • logLastDatabaseError
  • Logout
  • logSpider
  • logTriggersUpdates
  • MaintainCleanCache
  • MaintainDatabase
  • MaintainEmptyUnimportantLogs
  • MaintainFiles
  • MaintainFindFixErrors
  • MaintainMassMoveTopics
  • MaintainMembers
  • MaintainPurgeInactiveMembers
  • MaintainReattributePosts
  • MaintainRecountPosts
  • MaintainRemoveOldDrafts
  • MaintainRemoveOldPosts
  • MaintainRoutine
  • MaintainTopics
  • makeCustomFieldChanges
  • makeFilesWritable
  • makeNotificationChanges
  • makeThemeChanges
  • ManageAttachmentPaths
  • ManageAttachments
  • ManageAttachmentSettings
  • ManageAvatarSettings
  • ManageBoards
  • ManageBoardsMain
  • ManageCalendar
  • ManageLabels
  • ManageLanguages
  • ManageMail
  • ManageMaintenance
  • ManageNews
  • ManagePaidSubscriptions
  • ManagePostSettings
  • ManageRules
  • ManageScheduledTasks
  • ManageSearch
  • ManageSearchEngineSettings
  • ManageSmileys
  • markBoardsRead
  • markMessages
  • MarkRead
  • matchHighestPackageVersion
  • matchIPtoCIDR
  • matchPackageVersion
  • md5_hmac
  • MembergroupIndex
  • MembergroupMembers
  • MemberGroupsReport
  • Memberlist
  • membersAllowedTo
  • MembersAwaitingActivation
  • memoryReturnBytes
  • MergeDone
  • MergeExecute
  • MergeIndex
  • mergePosts
  • MergeTopics
  • MessageActionsApply
  • MessageDrafts
  • MessageFolder
  • MessageIndex
  • messageIndexBar
  • MessageKillAll
  • MessageMain
  • MessagePopup
  • MessagePost
  • MessagePost2
  • messagePostError
  • MessagePrune
  • MessageSearch
  • MessageSearch2
  • MessageSettings
  • mimespecialchars
  • mktree
  • MLAll
  • MLSearch
  • ModBlockGroupRequests
  • ModBlockNotes
  • ModBlockReportedMembers
  • ModBlockReportedPosts
  • ModBlockWatchedUsers
  • ModEndSession
  • ModerateGroups
  • ModerationHome
  • ModerationMain
  • ModerationSettings
  • ModifyAlertsSettings
  • ModifyAntispamSettings
  • ModifyBasicSettings
  • ModifyBBCSettings
  • modifyBoard
  • ModifyCacheSettings
  • ModifyCalendarSettings
  • ModifyCat
  • modifyCategory
  • ModifyCookieSettings
  • ModifyDatabaseSettings
  • ModifyDraftSettings
  • modifyEvent
  • ModifyFeatureSettings
  • ModifyGeneralModSettings
  • ModifyGeneralSecuritySettings
  • ModifyGeneralSettings
  • ModifyHolidays
  • ModifyLanguage
  • ModifyLanguages
  • ModifyLanguageSettings
  • ModifyLayoutSettings
  • ModifyLikesSettings
  • ModifyLoadBalancingSettings
  • ModifyLogSettings
  • ModifyMailSettings
  • ModifyMembergroup
  • ModifyMembergroup2
  • ModifyMembergroups
  • ModifyMembergroupsettings
  • ModifyMentionsSettings
  • ModifyModSettings
  • ModifyNewsSettings
  • ModifyPermissions
  • modifyPost
  • ModifyPostModeration
  • ModifyPostSettings
  • ModifyProfile
  • ModifyRegistrationSettings
  • ModifySettings
  • ModifySignatureSettings
  • ModifySubscription
  • ModifySubscriptionSettings
  • ModifyTopicSettings
  • ModifyUserSubscription
  • ModifyWarningSettings
  • ModifyWarningTemplate
  • MoveTopic
  • MoveTopic2
  • moveTopicConcurrence
  • moveTopics
  • MySQLConvertOldIp
  • newsletterpreview
  • newspreview
  • newTable
  • next_time
  • nextSubstep
  • notification
  • ob_sessrewrite
  • obExit
  • obExit_cron
  • OptimizeTables
  • package_chmod
  • package_create_backup
  • package_crypt
  • package_flush_cache
  • package_get_contents
  • package_put_contents
  • PackageBrowse
  • PackageDownload
  • PackageFTPTest
  • PackageGBrowse
  • PackageGet
  • PackageInstall
  • PackageInstallTest
  • PackageList
  • PackageOptions
  • PackagePermissions
  • PackagePermissionsAction
  • PackageRemove
  • packageRequireFTP
  • Packages
  • PackageServerAdd
  • PackageServerRemove
  • PackageServers
  • PackageUpload
  • parse_bbc
  • parse_path
  • parse_sql
  • parseAttachBBC
  • parseBoardMod
  • parseModification
  • parsePackageInfo
  • parsesmileys
  • password_get_info
  • password_hash
  • password_needs_rehash
  • password_verify
  • pauseAttachmentMaintenance
  • pauseMailQueueClear
  • pauseRepairProcess
  • pauseSignatureApplySettings
  • perform_task
  • PermissionByBoard
  • PermissionIndex
  • permute
  • php_version_check
  • phpBB3_password_check
  • PickTheme
  • PlushSearch1
  • PlushSearch2
  • populateDuplicateMembers
  • Post
  • Post2
  • PostModerationMain
  • prepareAttachsByMsg
  • prepareCLIhandler
  • prepareDBSettingContext
  • prepareDisplayContext
  • prepareLikesContext
  • prepareMailingForPreview
  • prepareMessageContext
  • prepareSearchContext
  • prepareServerSettingsContext
  • preparsecode
  • print_error
  • printMemberListRows
  • PrintTopic
  • processAttachments
  • profile_popup
  • profileLoadAvatarData
  • profileLoadGroups
  • profileLoadLanguages
  • profileLoadSignatureData
  • profileReloadUser
  • profileSaveAvatarData
  • profileSaveGroups
  • profileSendActivation
  • profileValidateEmail
  • profileValidateSignature
  • protected_alter
  • quickFileWritable
  • QuickInTopicModeration
  • QuickModeration
  • QuoteFast
  • random_bytes
  • random_int
  • RandomCompat_intval
  • RandomCompat_strlen
  • RandomCompat_substr
  • range2ip
  • read_tgz_data
  • read_tgz_file
  • read_zip_data
  • read_zip_file
  • ReadDraft
  • reapplySubscriptions
  • reattributePosts
  • rebuildModCache
  • recacheSpiderNames
  • RecentPosts
  • recountOpenReports
  • recursiveBoards
  • redirectexit
  • redirectLocation
  • ReduceMailQueue
  • reencodeImage
  • RegCenter
  • Register
  • Register2
  • RegisterCheckUsername
  • registerMember
  • registerSMStats
  • reloadSettings
  • RemindMe
  • RemindPick
  • remove_dir
  • remove_integration_function
  • remove_theme
  • RemoveAllAttachments
  • RemoveAttachment
  • RemoveAttachmentByAge
  • RemoveAttachmentBySize
  • removeBanGroups
  • removeBanLogs
  • removeBanTriggers
  • removeDeleteConcurrence
  • removeEvent
  • removeHolidays
  • removeIllegalBBCHtmlPermission
  • removeMembersFromGroups
  • removeMessage
  • removeMessages
  • RemoveOldTopics2
  • RemovePoll
  • removeSubscription
  • RemoveTheme
  • RemoveTopic2
  • removeTopics
  • reorderBoards
  • RepairAttachments
  • RepairBoards
  • replaceEntities__callback
  • ReportDetails
  • ReportedContent
  • ReportedMembers
  • ReportMessage
  • reportPost
  • ReportsMain
  • ReportToModerator
  • ReportToModerator2
  • reportUser
  • RequestMembers
  • resetPassword
  • resizeImage
  • resizeImageFile
  • RestoreTopic
  • RetrievePreview
  • safe_file_write
  • safe_serialize
  • safe_unserialize
  • sanitize_iri
  • sanitizeMSCutPaste
  • saveDBSettings
  • SaveDraft
  • saveModComment
  • SavePMDraft
  • saveProfileChanges
  • saveProfileFields
  • saveSettings
  • saveTriggers
  • scheduled_birthdayemails
  • scheduled_daily_digest
  • scheduled_daily_maintenance
  • scheduled_fetchSMfiles
  • scheduled_paid_subscriptions
  • scheduled_remove_old_drafts
  • scheduled_remove_temp_attachments
  • scheduled_remove_topic_redirect
  • scheduled_weekly_digest
  • scheduled_weekly_maintenance
  • ScheduledTasks
  • SearchEngines
  • SearchMembers
  • searchSort
  • SecretAnswer2
  • SecretAnswerInput
  • secureDirectory
  • SelectMailingMembers
  • send_http_status
  • SendActivation
  • sendmail
  • SendMailing
  • sendNotifications
  • sendpm
  • sentence_list
  • serialize_to_json
  • sessionClose
  • sessionDestroy
  • sessionGC
  • sessionOpen
  • sessionRead
  • sessionWrite
  • set_alert_icon
  • set_avatar_data
  • set_fatal_error_headers
  • set_tld_regex
  • SetCensor
  • setEventStartEnd
  • SetJavaScript
  • setKeys
  • setLoginCookie
  • setMemoryLimit
  • setNotifyPrefs
  • setPassword
  • setPassword2
  • SetQuickGroups
  • SetReserved
  • setSqlMode
  • setTFACookie
  • SetThemeOptions
  • SetThemeSettings
  • setup_fatal_error_context
  • setupMenuContext
  • setupProfileContext
  • setupThemeContext
  • sha1_core
  • sha1_ft
  • sha1_kt
  • sha1_raw
  • sha1_rol
  • sha1_smf
  • shorten_subject
  • ShowAdminHelp
  • showAlerts
  • showAttachment
  • showAttachments
  • ShowClosedReports
  • showCodeImage
  • ShowCustomProfiles
  • ShowDrafts
  • ShowHelp
  • showLetterImage
  • ShowNotice
  • showPermissions
  • ShowPHPinfoSettings
  • showPMDrafts
  • showPosts
  • showProfileDrafts
  • ShowReports
  • showUnwatched
  • ShowXmlFeed
  • sig_preview
  • smf_chmod
  • smf_crc32
  • smf_db_add_column
  • smf_db_add_index
  • smf_db_affected_rows
  • smf_db_allow_persistent
  • smf_db_backup_table
  • smf_db_calculate_type
  • smf_db_change_column
  • smf_db_create_query_column
  • smf_db_create_table
  • smf_db_create_word_search
  • smf_db_cte_support
  • smf_db_custom_order
  • smf_db_drop_table
  • smf_db_error
  • smf_db_error_backtrace
  • smf_db_error_insert
  • smf_db_escape_string
  • smf_db_escape_wildcard_string
  • smf_db_fetch_all
  • smf_db_get_server_info
  • smf_db_get_vendor
  • smf_db_get_version
  • smf_db_initiate
  • smf_db_insert
  • smf_db_insert_id
  • smf_db_list_columns
  • smf_db_list_indexes
  • smf_db_list_tables
  • smf_db_native_replace
  • smf_db_optimize_table
  • smf_db_query
  • smf_db_quote
  • smf_db_remove_column
  • smf_db_remove_index
  • smf_db_replacement__callback
  • smf_db_search_language
  • smf_db_search_query
  • smf_db_search_support
  • smf_db_select
  • smf_db_select_db
  • smf_db_table_sql
  • smf_db_table_structure
  • smf_db_transaction
  • smf_db_version
  • smf_error_handler
  • smf_error_handler_cron
  • smf_is_resource
  • smf_json_decode
  • smf_list_timezones
  • smf_main
  • smf_mysql_fetch_assoc
  • smf_mysql_fetch_row
  • smf_mysql_free_result
  • smf_mysql_insert_id
  • smf_mysql_num_rows
  • smf_mysql_real_escape_string
  • smf_seed_generator
  • smf_serverResponse
  • smf_setcookie
  • smf_strtolower
  • smf_var_export
  • SMStats
  • sortBoards
  • sortCategories
  • spamProtection
  • spell_check
  • spell_init
  • spell_suggest
  • SpellCheck
  • SpiderCheck
  • SpiderLogs
  • SpiderStats
  • SplitExecute
  • SplitIndex
  • SplitSelectionExecute
  • SplitSelectTopics
  • splitTopic
  • SplitTopics
  • ssi_boardNews
  • ssi_boardStats
  • ssi_checkPassword
  • ssi_copyright
  • ssi_fetchGroupMembers
  • ssi_fetchMember
  • ssi_fetchPosts
  • ssi_full_version
  • ssi_latestMember
  • ssi_login
  • ssi_logOnline
  • ssi_logout
  • ssi_menubar
  • ssi_news
  • ssi_pollVote
  • ssi_queryMembers
  • ssi_queryPosts
  • ssi_quickSearch
  • ssi_randomMember
  • ssi_recentAttachments
  • ssi_recentEvents
  • ssi_recentPoll
  • ssi_recentPosts
  • ssi_recentTopics
  • ssi_showPoll
  • ssi_shutdown
  • ssi_software_year
  • ssi_todaysBirthdays
  • ssi_todaysCalendar
  • ssi_todaysEvents
  • ssi_todaysHolidays
  • ssi_topBoards
  • ssi_topPoll
  • ssi_topPoster
  • ssi_topTopics
  • ssi_topTopicsReplies
  • ssi_topTopicsViews
  • ssi_version
  • ssi_welcome
  • ssi_whosOnline
  • ssl_cert_found
  • StaffReport
  • statPanel
  • Sticky
  • strip_php_comments
  • stripslashes__recursive
  • subscriptions
  • summary
  • TaskLog
  • TaskSettings
  • template_action_permissions
  • template_add_edit_group_boards_list
  • template_add_language
  • template_add_rule
  • template_additional_rows
  • template_addsmiley
  • template_admin
  • template_admin_account
  • template_admin_browse
  • template_admin_login
  • template_admin_quick_search
  • template_admin_register
  • template_admin_search_results
  • template_after
  • template_alert_configuration
  • template_alert_notifications_boards
  • template_alert_notifications_topics
  • template_alerts_all_read
  • template_alerts_popup
  • template_announce
  • template_announcement_send
  • template_ask
  • template_ask_delete
  • template_attachment_errors
  • template_attachment_paths
  • template_attachment_repair
  • template_avatar_settings_above
  • template_avatar_settings_below
  • template_backup_database
  • template_backup_xml
  • template_ban_edit
  • template_ban_edit_trigger
  • template_bcd
  • template_bi_board_children
  • template_bi_board_icon
  • template_bi_board_info
  • template_bi_board_lastpost
  • template_bi_board_stats
  • template_bi_redirect_icon
  • template_bi_redirect_stats
  • template_boardindex_outer_above
  • template_boardindex_outer_below
  • template_body_above
  • template_body_below
  • template_browse
  • template_button_strip
  • template_by_board
  • template_calendar_top
  • template_callback_question_answer_list
  • template_check_username
  • template_chmod
  • template_chmod_files
  • template_choose_payment
  • template_clean_cache_button_above
  • template_clean_cache_button_below
  • template_confirm_board_delete
  • template_confirm_category_delete
  • template_control_chmod
  • template_control_richedit
  • template_control_richedit_buttons
  • template_control_verification
  • template_convert_entities
  • template_convert_msgbody
  • template_convert_utf8
  • template_convert_xml
  • template_coppa
  • template_coppa_form
  • template_copy_template
  • template_create_index
  • template_create_index_done
  • template_create_index_progress
  • template_create_list_menu
  • template_credits
  • template_css
  • template_database_changes
  • template_database_settings
  • template_database_xml
  • template_delete_install
  • template_delete_subscription
  • template_deleteAccount
  • template_download_language
  • template_downloaded
  • template_edit_agreement
  • template_edit_browse
  • template_edit_censored
  • template_edit_comment
  • template_edit_file
  • template_edit_group
  • template_edit_holiday
  • template_edit_list
  • template_edit_options
  • template_edit_profile_field
  • template_edit_profiles
  • template_edit_reserved_words
  • template_edit_scheduled_tasks
  • template_edit_style
  • template_edit_template
  • template_editBuddies
  • template_editicon
  • template_editicons
  • template_editIgnoreList
  • template_editsets
  • template_email_members
  • template_email_members_compose
  • template_email_members_send
  • template_error_log
  • template_error_message
  • template_event_post
  • template_examine
  • template_extract_package
  • template_fatal_error
  • template_file_permissions
  • template_find_members
  • template_folder
  • template_footer
  • template_forum_settings
  • template_ftp_required
  • template_generic
  • template_generic_menu
  • template_generic_menu_dropdown_above
  • template_generic_menu_dropdown_below
  • template_generic_menu_tabs
  • template_generic_xml
  • template_generic_xml_recursive
  • template_group_members
  • template_group_request_reason
  • template_group_requests_block
  • template_groupMembership
  • template_header
  • template_hms
  • template_homepage_sample1
  • template_homepage_sample1_html
  • template_homepage_sample1_php
  • template_html_above
  • template_html_below
  • template_ic_block_calendar
  • template_ic_block_online
  • template_ic_block_recent
  • template_ic_block_stats
  • template_ignoreboards
  • template_include
  • template_info_center
  • template_init
  • template_inline_permissions
  • template_install_above
  • template_install_below
  • template_install_options
  • template_installed
  • template_issueWarning
  • template_javascript
  • template_jump_to
  • template_kick_guest
  • template_labels
  • template_like
  • template_list
  • template_list_themes
  • template_load_warning_variables
  • template_login
  • template_login_tfa
  • template_mailtest
  • template_main
  • template_maint_warning_above
  • template_maint_warning_below
  • template_maintain_database
  • template_maintain_members
  • template_maintain_routine
  • template_maintain_topics
  • template_maintenance
  • template_manual
  • template_max_size
  • template_menu
  • template_merge
  • template_merge_done
  • template_merge_extra_options
  • template_message_icons
  • template_moderation_center
  • template_moderation_settings
  • template_modify_board
  • template_modify_category
  • template_modify_group
  • template_modify_group_display
  • template_modify_language_entries
  • template_modify_subscription
  • template_modify_user_subscription
  • template_modify_weights
  • template_modifydone
  • template_modifyfast
  • template_modifyset
  • template_modifysmiley
  • template_modifytopicdone
  • template_move
  • template_new_group
  • template_news_lists
  • template_newsfader
  • template_not_done
  • template_notes
  • template_notify_board
  • template_omfg
  • template_optimize
  • template_options
  • template_package_confirm
  • template_package_list
  • template_paid_done
  • template_permission_index
  • template_permission_show_contents
  • template_php_info
  • template_pick
  • template_pm
  • template_pm_above
  • template_pm_below
  • template_pm_popup
  • template_populate_database
  • template_popup
  • template_post
  • template_post_header
  • template_postmod_permissions
  • template_print
  • template_print_above
  • template_print_below
  • template_print_options
  • template_profile_above
  • template_profile_avatar_select
  • template_profile_below
  • template_profile_birthdate
  • template_profile_group_manage
  • template_profile_pm_settings
  • template_profile_popup
  • template_profile_save
  • template_profile_signature_modify
  • template_profile_smiley_pick
  • template_profile_tfa
  • template_profile_theme_pick
  • template_profile_theme_settings
  • template_profile_timeformat_modify
  • template_prune
  • template_quickbuttons
  • template_quickreply
  • template_quotefast
  • template_recent
  • template_redirect_options
  • template_registration_agreement
  • template_registration_form
  • template_reminder_pick
  • template_repair_boards
  • template_replies
  • template_report_message
  • template_report_message_complete
  • template_report_type
  • template_reported_members
  • template_reported_members_block
  • template_reported_posts
  • template_reported_posts_block
  • template_reported_users_block
  • template_resend
  • template_reset_list
  • template_results
  • template_retry_activate
  • template_rules
  • template_search
  • template_search_members
  • template_search_results
  • template_select
  • template_select_search_method
  • template_send
  • template_sendbody
  • template_sent
  • template_serialize_json
  • template_serialize_json_xml
  • template_servers
  • template_set_options
  • template_set_password
  • template_set_settings
  • template_setorder
  • template_settings
  • template_show_backtrace
  • template_show_custom_profile
  • template_show_file
  • template_show_list
  • template_show_month_grid
  • template_show_notice
  • template_show_settings
  • template_show_spider_logs
  • template_show_spider_stats
  • template_show_upcoming_list
  • template_show_week_grid
  • template_showAlerts
  • template_showDrafts
  • template_showPermissions
  • template_showPMDrafts
  • template_showPosts
  • template_single_pm
  • template_single_post
  • template_spellcheck
  • template_spider_edit
  • template_split
  • template_ssi_above
  • template_ssi_below
  • template_statPanel
  • template_stats
  • template_subject_list
  • template_summary
  • template_terms
  • template_tfadisable
  • template_tfasetup
  • template_tfasetup_backup
  • template_thetime
  • template_topic_legend
  • template_trackActivity
  • template_trackIP
  • template_unapproved_posts
  • template_unread
  • template_upgrade_above
  • template_upgrade_below
  • template_upgrade_complete
  • template_upgrade_options
  • template_user_subscription
  • template_user_watch_post_callback
  • template_verification_sound
  • template_view_operations
  • template_view_package
  • template_view_scheduled_tasks
  • template_view_versions
  • template_viewmemberreport
  • template_viewmodreport
  • template_viewWarning
  • template_warn_template
  • template_warning
  • template_warning_divs
  • template_watched_users
  • template_welcome_message
  • template_xml_above
  • template_xml_below
  • TestMailSend
  • text2words
  • textfield_alter
  • tfadisable
  • tfasetup
  • theme
  • theme_copyright
  • theme_inline_permissions
  • theme_install
  • theme_linktree
  • ThemeAdmin
  • ThemeInstall
  • ThemeList
  • ThemesMain
  • throw_error
  • time_since
  • timeformat
  • TopicNotify
  • trackActivity
  • trackEdits
  • trackGroupReq
  • tracking
  • TrackIP
  • TrackLogins
  • trackStats
  • trackStatsUsersOnline
  • TransferAttachments
  • truncate_array
  • un_htmlspecialchars
  • un_preparsecode
  • UnapprovedAttachments
  • UnapprovedPosts
  • unescapestring__recursive
  • UnreadTopics
  • updateAdminPreferences
  • updateBanGroup
  • updateBanMembers
  • updateBoardManagers
  • updateChildPermissions
  • updateDbLastError
  • updateLastMessages
  • updateMemberData
  • updateReport
  • updateSettings
  • updateSettingsFile
  • updateStats
  • updateTriggers
  • upgrade_clean_cache
  • upgrade_query
  • upgradeExit
  • upgradeGetColumnInfo
  • UpgradeOptions
  • url_exists
  • url_image_size
  • url_parts
  • url_to_iri
  • urldecode__recursive
  • user_info_callback
  • utf8_strtolower
  • utf8_strtoupper
  • validate_iri
  • validateEventPost
  • validatePassword
  • validatePasswordFlood
  • validateSession
  • validateToken
  • validateTriggers
  • validateUsername
  • VerificationCode
  • VersionDetail
  • ViewBacktrace
  • ViewErrorLog
  • ViewFile
  • ViewMemberlist
  • ViewMembers
  • ViewModlog
  • ViewOperations
  • ViewQuery
  • ViewSpiders
  • ViewSubscribedUsers
  • ViewSubscriptions
  • viewWarning
  • ViewWarningLog
  • ViewWarnings
  • ViewWarningTemplates
  • ViewWatchedUsers
  • Vote
  • warning_preview
  • Welcome
  • WelcomeLogin
  • Who
  • WrapAction
  • writeLog
  • XmlDraft
  • XMLhttpMain
  • Overview
  • Namespace
  • Class

No namespace

Classes summary
apc_cache Our Cache API class
apcu_cache Our Cache API class
ApprovePost_Notify_Background Class ApprovePost_Notify_Background
ApproveReply_Notify_Background Class ApproveReply_Notify_Background
Attachments
Birthday_Notify_Background Class Birthday_Notify_Background
browser_detector

Class browser_detector This class is an experiment for the job of correctly detecting browsers and settings needed for them. - Detects the following browsers - Opera, Webkit, Firefox, Web_tv, Konqueror, IE, Gecko - Webkit variants: Chrome, iphone, blackberry, android, safari, ipad, ipod - Opera Versions: 6, 7, 8 ... 10 ... and mobile mini and mobi - Firefox Versions: 1, 2, 3 .... 11 ... - Chrome Versions: 1 ... 18 ... - IE Versions: 4, 5, 5.5, 6, 7, 8, 9, 10 ... mobile and Mac - MS Edge - Nokia

Buddy_Notify_Background Class Buddy_Notify_Background
cache_api Class cache_api
CreateAttachment_Notify_Background Class CreateAttachment_Notify_Background
CreatePost_Notify_Background Class CreatePost_Notify_Background
curl_fetch_web_data

Class curl_fetch_web_data Simple cURL class to fetch a web page Properly redirects even with safe mode and basedir restrictions Can provide simple post options to a page

custom_search

Used for the "custom search index" option Class custom_search

EventNew_Notify_Background Class EventNew_Notify_Background
ftp_connection

Class ftp_connection Simple FTP protocol implementation.

fulltext_search

Class fulltext_search Used for fulltext index searching

gif_color_table
gif_file
gif_file_header
gif_image
gif_image_header
gif_lzw_compression Class gif_lzw_compression
GroupAct_Notify_Background Class GroupAct_Notify_Background
GroupReq_Notify_Background Class GroupReq_Notify_Background
Likes Class Likes
Likes_Notify_Background Class Likes_Notify_Background
MemberReport_Notify_Background Class MemberReport_Notify_Background
MemberReportReply_Notify_Background Class MemberReportReply_Notify_Background
memcache_cache Our Cache API class
memcached_cache Our Cache API class
Mentions

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

MsgReport_Notify_Background Class MsgReport_Notify_Background
MsgReportReply_Notify_Background Class MsgReportReply_Notify_Background
paypal_display Class for returning available form data for this gateway
paypal_payment Class of functions to validate a IPN response and provide details of the payment
postgres_cache PostgreSQL Cache API class
ProxyServer Class ProxyServer
Punycode Punycode implementation as described in RFC 3492
Register_Notify_Background Class Register_Notify_Background
search_api Class search_api
SMF_BackgroundTask Class SMF_BackgroundTask
smf_cache Our Cache API class
sqlite_cache SQLite Cache API class
standard_search Standard non full index, non custom index search
TypeError
Update_TLD_Regex Class Update_TLD_Regex
xcache_cache Our Cache API class
xmlArray

Class xmlArray Represents an XML array

zend_cache Our Cache API class
Interfaces summary
cache_api_interface Interface cache_api_interface
search_api_interface Interface search_api_interface
Exceptions summary
Error
Functions summary
_safe_serialize

Safe serialize() replacement. Recursive - output a strict subset of PHP's native serialized representation - does not serialize objects

_safe_unserialize

Safe unserialize() replacement - accepts a strict subset of PHP's native serialized representation - does not unserialize objects

account Handles the account section of the profile
Activate Activate an users account.
activateAccount Activate an account.
add_integration_function

Add a function for integration hook. does nothing if the function is already added.

addData

Adds an array of data into an existing table. if there are no existing tables, will create one with default attributes. if custom_table isn't specified, it will use the last table created, if it is specified and doesn't exist the function will return false. if a set of keys have been specified, the function will check each required key is present in the incoming data. If this data is missing the current tables default value will be used. if any key in the incoming data begins with '#sep#', the function will add a separator across the table at this point. once the incoming data has been sanitized, it is added to the table.

addInlineCss Add a block of inline css code to be executed later
addInlineJavaScript Add a block of inline Javascript code to be executed later
addJavaScriptVar

Add a Javascript variable for output later (for feeding text strings and similar to JS) Cleaner and easier (for modders) than to use the function below.

AddLanguage Interface for adding a new language
AddMailQueue Add an email to the mail queue.
AddMembergroup

This function handles adding a membergroup and setting some initial properties. Called by ?action=admin;area=membergroups;sa=add. It requires the manage_membergroups permission. Allows to use a predefined permission profile or copy one from another group. Redirects to action=admin;area=membergroups;sa=edit;group=x.

addMembersToGroup Add one or more members to a membergroup
addSeparator Add a separator row, only really used when adding data by rows.
AddSmiley Add a smiley, that's right.
addSubscription Add or extend a subscription of a user.
addTriggers This function actually inserts the ban triggers into the database
AdminAccount
AdminApprove

This function handles the approval, rejection, activation or deletion of members. Called by ?action=admin;area=viewmembers;sa=approve. Requires the moderate_forum permission. Redirects to ?action=admin;area=viewmembers;sa=browse with the same parameters as the calling page.

AdminBoardRecount

Recount many forum totals that can be recounted automatically without harm. it requires the admin_forum permission. It shows the maintain_forum admin area.

AdminEndSession This ends a admin session, requiring authentication to access the ACP again.
AdminHome

The main administration section. It prepares all the data necessary for the administration front page. It uses the Admin template along with the admin sub template. It requires the moderate_forum, manage_membergroups, manage_bans, admin_forum, manage_permissions, manage_attachments, manage_smileys, manage_boards, edit_news, or send_mail permission. It uses the index administrative area. It can be found by going to ?action=admin.

adminLogin

Question the verity of the admin by asking for his or her password. - loads Login.template.php and uses the admin_login sub template. - sends data to template so the admin is sent on to the page they wanted if their password is correct, otherwise they can try again.

adminLogin_outputPostVars

Used by the adminLogin() function. if 'value' is an array, the function is called recursively.

AdminLogs This function decides which log to load.
AdminMain

The main admin handling function.
It initialises all the basic context required for the admin center.
It passes execution onto the relevant admin section.
If the passed section is not found it shows the admin home page.

adminNotify

This simple function gets a list of all administrators and sends them an email to let them know a new member has joined. Called by registerMember() function in Subs-Members.php. Email is sent to all groups that have the moderate_forum permission. The language set by each member is being used (if available).

AdminRegister

This function allows the admin to register a new member by hand. It also allows assigning a primary group to the member being registered. Accessed by ?action=admin;area=regcenter;sa=register Requires the moderate_forum permission.

AdminSearch This function allocates out all the search stuff.
AdminSearchInternal A complicated but relatively quick internal search.
AdminSearchMember

All this does is pass through to manage members. ViewMembers()

AdminSearchOM This file allows the user to search the SM online manual for a little of help.
alert_configuration Handles configuration of alert preferences
alert_count

Counts how many alerts a user has - either unread or all depending on $unread We can't use db_num_rows here, as we have to determine what boards the user can see Possibly in future versions as database support for json is mainstream, we can simplify this.

alert_delete Deletes a single or a group of alerts by ID
alert_mark Marks a group of alerts as un/read
alert_markread Marks all alerts as read for the specified user
alert_notifications_boards Handles preferences related to board-level notifications
alert_notifications_topics Handles alerts related to topics and posts
alert_purge Deletes all the alerts that a user has already read.
alerts_popup Set up the requirements for the alerts popup - the area that shows all the alerts just quickly for the current user.
AlignURLsWithSSLSetting Align URLs with SSL Setting.
allowedTo

Check the user's permissions. checks whether the user is allowed to do permission. (ie. post_new.) If boards is specified, checks those boards instead of the current one. If any is true, will return true if the user has the permission on any of the specified boards Always returns true if the user is an administrator.

AnnouncementSelectMembergroup Allow a user to chose the membergroups to send the announcement to.
AnnouncementSend Send the announcement in chunks.
AnnounceTopic Handle the announce topic function (action=announce).
ApplyRules This will apply rules to all unread messages. If all_messages is set will, clearly, do it to all!
approveAllData This is a helper function - basically approve everything!
ApproveAttach Called from a mouse click, works out what we want to do with attachments and actions it.
ApproveAttachments Approve an attachment, or maybe even more - no permission check!
ApproveMessage Approve a post, just the one.
approveMessages Approve a batch of posts (or topics in their own right)
approvePosts Approve (or not) some posts... without permission checks...
approveTopics Approve topics?
array_column
array_length array_length Recursive
assignAttachments Assigns the given attachments to the given message ID.
attachDirStatus

Checks the status of an attachment directory and returns an array of the status key, if that status key signifies an error, and the file count.

attachmentChecks

Performs various checks on an uploaded file. - Requires that $_SESSION['temp_attachments'][$attachID] be properly populated.

attachments_init_dir Return the first part of a path (i.e. c:\ or / + the first directory), used by automanage_attachments_create_directory
automanage_attachments_by_space

Called when a directory space limit is reached. Creates a new directory and increments the directory suffix number.

automanage_attachments_check_directory

Check if the current directory is still valid or not. If not creates the new directory

automanage_attachments_create_directory Creates a directory
AutoSuggest_Search_Member Search for a member - by real_name or member_name by default.
AutoSuggest_Search_MemberGroups Search for a membergroup by name
AutoSuggest_Search_SMFVersions Provides a list of possible SMF versions to use in emulation
AutoSuggestHandler This keeps track of all registered handling functions for auto suggest functionality and passes execution to them.
AutoTask This function works out what to do!
BackupDatabase
backupTable
Ban

Ban center. The main entrance point for all ban center functions. It is accesssed by ?action=admin;area=ban. It choses a function based on the 'sa' parameter, like many others. The default sub-action is BanList(). It requires the ban_members permission. It initializes the admin tabs.

BanBrowseTriggers

This handles the screen for showing the banned entities It is accessed by ?action=admin;area=ban;sa=browse It uses sub-tabs for browsing by IP, hostname, email or username.

BanEdit

This function is behind the screen for adding new bans and modifying existing ones. Adding new bans: - is accessed by ?action=admin;area=ban;sa=add. - uses the ban_edit sub template of the ManageBans template. Modifying existing bans: - is accessed by ?action=admin;area=ban;sa=edit;bg=x - uses the ban_edit sub template of the ManageBans template. - shows a list of ban triggers for the specified ban.

banEdit2 This function handles submitted forms that add, modify or remove ban triggers.
BanEditTrigger

This function handles the ins and outs of the screen for adding new ban triggers or modifying existing ones. Adding new ban triggers: - is accessed by ?action=admin;area=ban;sa=edittrigger;bg=x - uses the ban_edit_trigger sub template of ManageBans. Editing existing ban triggers: - is accessed by ?action=admin;area=ban;sa=edittrigger;bg=x;bi=y - uses the ban_edit_trigger sub template of ManageBans.

BanList

Shows a list of bans currently set. It is accessed by ?action=admin;area=ban;sa=list. It removes expired bans. It allows sorting on different criteria. It also handles removal of selected ban items.

banLoadAdditionalIPs Finds additional IPs related to a certain user
banLoadAdditionalIPsError
banLoadAdditionalIPsMember
BanLog

This handles the listing of ban log entries, and allows their deletion. Shows a list of logged access attempts by banned users. It is accessed by ?action=admin;area=ban;sa=log. How it works: - allows sorting of several columns. - also handles deletion of (a selection of) log entries.

banPermissions

Fix permissions according to ban status. Applies any states of banning by removing permissions the user cannot have.

bbc_to_html

As of SMF 2.1, this is unused. But it is available if any mod wants to use it. Convert only the BBC that can be edited in HTML mode for the (old) editor.

BoardIndex

This function shows the board index. It uses the BoardIndex template, and main sub template. It updates the most online statistics. It is accessed by ?action=boardindex.

BoardNotify

Turn off/on notification for a particular board. Must be called with a board specified in the URL. Only uses the template if no sub action is used. (on/off) Redirects the user back to the board after it is done. Accessed via ?action=notifyboard.

BoardPermissionsReport

Generate a report on the current permissions by board and membergroup. functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

BoardReport

Standard report about what settings the boards have. functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

boardsAllowedTo

Return the boards a user has a certain (board) permission on. (array(0) if all.) - returns a list of boards on which the user is allowed to do the specified permission. - returns an array with only a 0 in it if the user has permission to do this on every board. - returns an empty array if he or she cannot do this on any board. If check_access is true will also make sure the group has proper access to that board.

BoardurlMatch $boardurl Match.
BookOfUnknown What's this? I dunno, what are you talking about? Never seen this before, nope. No sir.
BrowseFiles

Show a list of attachment or avatar files. Called by ?action=admin;area=manageattachments;sa=browse for attachments and ?action=admin;area=manageattachments;sa=browse;avatars for avatars. Allows sorting by name, date, size and member. Paginates results.

BrowseMailQueue Display the mail queue...
BuddyListToggle

This simple function adds/removes the passed user from the current users buddy list. Requires profile_identity_own permission. Called by ?action=buddy;u=x;session_id=y. Redirects to ?action=profile;u=x.

build_query_board Build query_wanna_see_board and query_see_board for a userid
build_regex Creates optimized regular expressions from an array of strings.
buildEventDatetimes Helper function for getEventRange, getEventProperties, getNewEventDatetimes, etc.
cache_get_data

Gets the value from the cache specified by key, so long as it is not older than ttl seconds. - It may often "miss", so shouldn't be depended on. - It supports the same as cache_put_data().

cache_getLastPosts Callback-function for the cache for getLastPosts().
cache_getMembergroupList Retrieve a list of (visible) membergroups used by the cache.
cache_getOffsetIndependentEvents

Retrieve all events for the given days, independently of the users offset. cache callback function used to retrieve the birthdays, holidays, and events between now and now + days_to_index. widens the search range by an extra 24 hours to support time offset shifts. used by the cache_getRecentEvents function to get the information needed to calculate the events taking the users time offset into account.

cache_getRecentEvents

cache callback function used to retrieve the upcoming birthdays, holidays, and events within the given period, taking into account the users time offset. Called from the BoardIndex to display the current day's events on the board index used by the board index and SSI to show the upcoming events.

cache_put_data Puts value in the cache under key for ttl seconds.
cache_quick_get Try to retrieve a cache entry. On failure, call the appropriate function.
CalculateNextTrigger Calculate the next time the passed tasks should be triggered.
CalendarMain

Show the calendar. It loads the specified month's events, holidays, and birthdays. It requires the calendar_view permission. It depends on the cal_enabled setting, and many of the other cal_ settings. It uses the calendar_start_day theme option. (Monday/Sunday) It uses the main sub template in the Calendar template. It goes to the month and year passed in 'month' and 'year' by get or post. It is accessed through ?action=calendar.

CalendarPost This function processes posting/editing/deleting a calendar event.
call_helper

Receives a string and tries to figure it out if its a method or a function. If a method is found, it looks for a "#" which indicates SMF should create a new instance of the given class. Checks the string/array for is_callable() and return false/fatal_lang_error is the given value results in a non callable string/array. Prepare and returns a callable depending on the type of method/function found.

call_integration_hook

Process functions of an integration hook. calls all functions of the given hook. supports static class method calls.

canLinkEvent

Does permission checks to see if an event can be linked to a board/topic. checks if the current user can link the current topic to the calendar, permissions et al. this requires the calendar_post permission, a forum moderator, or a topic starter. expects the $topic and $board variables to be set. if the user doesn't have proper permissions, an error will be shown.

canPickTheme Determines if a user can change their theme.
cdata_parse

Ensures supplied data is properly encapsulated in cdata xml tags Called from getXmlProfile in News.php

censorText

Replace all vulgar words with respective proper words. (substring or whole words..) What this function does: - it censors the passed string. - if the theme setting allow_no_censored is on, and the theme option show_no_censored is enabled, does not censor, unless force is also set. - it caches the list of censored words to reduce parsing.

check_cron Ensures SMF's scheduled tasks are being run as intended
checkActivation Check activation status of the current user.
checkChange
checkConfirm Check if a specific confirm parameter was given.
checkExistingTriggerIP

Checks whether a given IP range already exists in the trigger list. If yes, it returns an error message. Otherwise, it returns an array optimized for the database.

CheckFilesWritable
checkGD

Sets a global $gd2 variable needed by some functions to determine whether the GD2 library is present.

checkImageContents

Searches through the file to see if there's potentially harmful non-binary content. - if extensiveCheck is true, searches for asp/php short tags as well.

checkImagick Checks whether the Imagick class is present.
checkLogin
checkMagickWand Checks whether the MagickWand extension is present.
checkSession

Make sure the user's correct session was passed, and they came from here. Checks the current session, verifying that the person is who he or she should be. Also checks the referrer to make sure they didn't get sent here. Depends on the disableCheckUA setting, which is usually missing. Will check GET, POST, or REQUEST depending on the passed type. Also optionally checks the referring action if passed. (note that the referring action must be by GET.)

checkSubmitOnce

Check whether a form has been submitted twice. Registers a sequence number for a form. Checks whether a submitted sequence number is registered in the current session. Depending on the value of is_fatal shows an error or returns true or false. Frees a sequence number from the stack after it's been checked. Frees a sequence number without checking if action == 'free'.

clean_cache Empty out the cache in use as best it can
cleanLangString This function cleans language entries to/from display.
cleanRequest Clean the request variables - add html entities to GET and slashes if magic_quotes_gpc is Off.
cleanRequest_cron Cleans up the request variables
cleanTokens

Removes old unused tokens from session defaults to 3 hours before a token is considered expired if $complete = true will remove all tokens

cleanXml

Clean up the XML to make sure it doesn't contain invalid characters. What it does: - removes invalid XML characters to assure the input string being - parsed properly.

ClearMailQueue This function clears the mail queue of all emails, and at the end redirects to browse.
cli_scheduled_fetchSMfiles
clock Nothing to see here. Move along.
cmdStep0
comma_format
  • Formats a number.
  • uses the format of number_format to decide how to format the number. for example, it might display "1 234,50".
  • caches the formatting data from the setting for optimization.
compareVersions

Compares two versions and determines if one is newer, older or the same, returns - (-1) if version1 is lower than version2 - (0) if version1 is equal to version2 - (1) if version1 is higher than version2

ComposeMailing

Shows a form to edit a forum mailing and its recipients. Called by ?action=admin;area=news;sa=mailingcompose. Requires the send_mail permission. Form is submitted to ?action=admin;area=news;sa=mailingsend.

consolidateSpiderStats This function takes any unprocessed hits and turns them into stats.
construct_query_string Properly urlencodes a string to be used in a query
constructPageIndex Constructs a page list.
ConvertEntities

Converts HTML-entities to their UTF-8 character equivalents. This requires the admin_forum permission. Pre-condition: UTF-8 has been set as database and global character set.

ConvertMsgBody

Convert the column "body" of the table {db_prefix}messages from TEXT to MEDIUMTEXT and vice versa. It requires the admin_forum permission. This is needed only for MySQL. During the conversion from MEDIUMTEXT to TEXT it check if any of the posts exceed the TEXT length and if so it aborts. This action is linked from the maintenance screen (if it's applicable). Accessed by ?action=admin;area=maintain;sa=database;activity=convertmsgbody.

convertSettingstoOptions
convertSettingsToTheme
ConvertUtf8 Handles converting your database to UTF-8
CoppaForm This function will display the contact information for the forum, as well a form to fill in.
CopyTemplate Makes a copy of a template file in a new location
copytree

Copies one directory structure over to another. requires the destination to be writable.

countReports Counts how many reports are in total. Used for creating pagination.
create_button Creates an image/text button
create_chmod_control Create a chmod control for chmoding files.
create_control_richedit Creates a box that can be used for richedit stuff like BBC, Smileys etc.
create_control_verification Create a anti-bot verification control?
createAttachment

Create an attachment, with the given array of parameters. - Adds any additional or missing parameters to $attachmentOptions. - Renames the temporary file. - Creates a thumbnail if the file is an image and the option enabled.

createBoard

Create a new board and set its properties and position. Allows (almost) the same options as the modifyBoard() function. With the option inherit_permissions set, the parent board permissions will be inherited.

createCategory

Create a new category. general function to create a new category and set its position. allows (almost) the same options as the modifyCat() function. returns the ID of the newly created category.

createList Create a new list
createMenu Create a menu.
CreateMessageIndex

Create a custom search index for the messages table. Called by ?action=admin;area=managesearch;sa=createmsgindex. Linked from the EditSearchMethod screen. Requires the admin_forum permission. Depending on the size of the message table, the process is divided in steps.

createPost

Create a post, either as new topic (id_topic = 0) or in an existing one. The input parameters of this function assume: - Strings have been escaped. - Integers have been cast to integer. - Mandatory parameters are set.

createSalvageArea

Create a salvage area for repair purposes, if one doesn't already exist. Uses the forum's default language, and checks based on that name.

createThumbnail Create a thumbnail of the given source.
createToken Lets give you a token of our appreciation.
createWaveFile

Creates a wave file that spells the letters of $word. Tries the user's language first, and defaults to english. Used by VerificationCode() (Register.php).

Credits It prepares credit and copyright information for the credits page or the admin page
custFieldsMaxOrder Returns the maximum field_order value for the custom fields
custMinify

Get an array of previously defined files and adds them to our main minified files. Sets a one day cache to avoid re-creating a file on every request.

DatabaseChanges
DatabasePopulation
DatabaseSettings
db_extend
db_extra_init
db_fix_prefix
db_packages_init
db_search_init
db_version_check
debugPrint
deleteAccount Present a screen to make sure the user wants to be deleted
deleteAccount2 Actually delete an account.
deleteAllMinified Clears out old minimized CSS and JavaScript files and ensures $modSettings['browser_cache'] is up to date
deleteBoards

Remove one or more boards. Allows to move the children of the board before deleting it if moveChildrenTo is set to null, the child boards will be deleted. Deletes: - all topics that are on the given boards; - all information that's associated with the given boards; updates the statistics to reflect the new situation.

deleteCategories

Remove one or more categories. general function to delete one or more categories. allows to move all boards in the categories to a different category before deleting them. if moveChildrenTo is set to null, all boards inside the given categories will be deleted. deletes all information that's associated with the given categories. updates the statistics to reflect the new situation.

DeleteDraft

Deletes one or many drafts from the DB Validates the drafts are from the user is supplied an array of drafts will attempt to remove all of them

deleteErrors

Delete all or some of the errors in the error log. It applies any necessary filters to deletion. This should only be called by ViewErrorLog(). It attempts to TRUNCATE the table to reset the auto_increment. Redirects back to the error log when done.

DeleteInstall
DeleteMembergroup

Deleting a membergroup by URL (not implemented). Called by ?action=admin;area=membergroups;sa=delete;group=x;session_var=y. Requires the manage_membergroups permission. Redirects to ?action=admin;area=membergroups.

deleteMembergroups

Delete one of more membergroups. Requires the manage_membergroups permission. Returns true on success or false on failure. Has protection against deletion of protected membergroups. Deletes the permissions linked to the membergroup. Takes members out of the deleted membergroups.

deleteMembers

Delete one or more members. Requires profile_remove_own or profile_remove_any permission for respectively removing your own account or any account. Non-admins cannot delete admins. The function: - changes author of messages, topics and polls to guest authors. - removes all log entries concerning the deleted members, except the error logs, ban logs and moderation logs. - removes these members' personal messages (only the inbox), avatars, ban entries, theme settings, moderator positions, poll and votes. - updates member statistics afterwards.

DeleteMessage

Remove just a single post. On completion redirect to the topic or to the board.

deleteMessages Delete the specified personal messages.
deleteModComment Deletes a moderator comment from the DB.
deleteNotifyPrefs Deletes notification preference
DeleteUpgrade
deltree

Deletes a directory, and all the files and direcories inside it. requires access to delete these files.

Destroy Oh noes! I'd document this but that would give it away
destroyMenu Delete a menu.
detectBrowser

Loads information about what browser the user is viewing with and places it in $context - uses the class from Class-BrowserDetect.php

detectFulltextIndex

Checks if the message table already has a fulltext index created and returns the key name Determines if a db is capable of creating a fulltext index

determineActions This function determines the actions of the members passed in urls.
Display

The central part of the board - topic display. This function loads the posts in a topic up so they can be displayed. It uses the main sub template of the Display template. It requires a topic, and can go to the previous or next topic from it. It jumps to the correct post depending on a number/time/IS_MSG passed. It depends on the messages_per_page, defaultMaxMessages and enableAllMessages settings. It is accessed by ?topic=id_topic.START.

display_db_error

Show an error message for the connection problems. It shows a complete page independent of language files or themes. It is used only if there's no way to connect to the database. It stops further execution of the script.

display_loadavg_error

Show an error message for load average blocking problems. It shows a complete page independent of language files or themes. It is used only if the load averages are too high to continue execution. It stops further execution of the script.

display_maintenance_message

Show a message for the (full block) maintenance mode. It shows a complete page independent of language files or themes. It is used only if $maintenance = 2 in Settings.php. It stops further execution of the script.

DisplayAdminFile Get one of the admin information files from Simple Machines.
displayDebug

This function shows the debug information tracked when $db_show_debug = true in Settings.php

DisplayStats Display some useful/interesting board statistics.
DoLogin Perform the logging in. (set cookie, call hooks, etc)
Download

Once upon a time, this function handled downloading attachments. Now it's just an alias retained for the sake of backwards compatibility.

downloadAvatar

downloads a file from a url and stores it locally for avatar use by id_member. - supports GIF, JPG, PNG, BMP and WBMP formats. - detects if GD2 is available. - uses resizeImageFile() to resize to max_width by max_height, and saves the result to a file. - updates the database info for the member's avatar. - returns whether the download and resize was successful.

DownloadLanguage

Download a language file from the Simple Machines website. Requires a valid download ID ("did") in the URL. Also handles installing language files. Attempts to chmod things as needed. Uses a standard list to display information about all the files and where they'll be put.

dumpTags

Formats data retrieved in other functions into xml format. Additionally formats data based on the specific format passed. This function is recursively called to handle sub arrays of data.

EditAgreement

Allows the administrator to edit the registration agreement, and choose whether it should be shown or not. It writes and saves the agreement to the agreement.txt file. Accessed by ?action=admin;area=regcenter;sa=agreement. Requires the admin_forum permission.

EditBoard

Modify a specific board... screen for editing and repositioning a board. called by ?action=admin;area=manageboards;sa=board uses the modify_board sub-template of the ManageBoards template. requires manage_boards permission. also used to show the confirm deletion of category screen (sub-template confirm_board_delete).

EditBoard2

Make changes to/delete a board. (function for handling a submitted form saving the board.) It also handles deletion of a board. Called by ?action=admin;area=manageboards;sa=board2 Redirects to ?action=admin;area=manageboards. It requires manage_boards permission.

EditBoardSettings A screen to set a few general board and category settings.
editBuddies Show all the users buddies, as well as a add/delete interface.
editBuddyIgnoreLists Show all the users buddies, as well as a add/delete interface.
EditCategory

Modify a specific category. (screen for editing and repositioning a category.) Also used to show the confirm deletion of category screen (sub-template confirm_category_delete). Called by ?action=admin;area=manageboards;sa=cat Requires manage_boards permission.

EditCategory2

Function for handling a submitted form saving the category. (complete the modifications to a specific category.) It also handles deletion of a category. It requires manage_boards permission. Called by ?action=admin;area=manageboards;sa=cat2 Redirects to ?action=admin;area=manageboards.

EditComment

Shows a textarea for editing a moderator comment. Handles the edited comment and stores it on the DB.

EditCustomProfiles Edit some profile fields?
EditHoliday This function is used for adding/editing a specific holiday
editIgnoreList Allows the user to view their ignore list, as well as the option to manage members on it.
EditMembergroup

Editing a membergroup. Screen to edit a specific membergroup. Called by ?action=admin;area=membergroups;sa=edit;group=x. It requires the manage_membergroups permission. Also handles the delete button of the edit form. Redirects to ?action=admin;area=membergroups.

EditMessageIcons Handles editing message icons
editModComment Saves the new information whenever a moderator comment is edited.
EditNews

Let the administrator(s) edit the news items for the forum. It writes an entry into the moderation log. This function uses the edit_news administration area. Called by ?action=admin;area=news. Requires the edit_news permission. Can be accessed with ?action=admin;sa=editnews.

EditPermissionProfiles Add/Edit/Delete profiles.
EditPoll

Display screen for editing or adding a poll. Must be called with a topic specified in the URL. If the user is adding a poll to a topic, must contain the variable 'add' in the url. User must have poll_edit_any/poll_add_any permission for the relevant action, otherwise must be poll starter with poll_edit_own permission for editing, or be topic starter with poll_add_any permission for adding. Accessed via ?action=editpoll.

EditPoll2

Update the settings for a poll, or add a new one. Must be called with a topic specified in the URL. The user must have poll_edit_any/poll_add_any permission for the relevant action. Otherwise they must be poll starter with poll_edit_own permission for editing, or be topic starter with poll_add_any permission for adding. In the case of an error, this function will redirect back to EditPoll and display the relevant error message. Upon successful completion of action will direct user back to topic. Accessed via ?action=editpoll2.

EditSearchMethod

Edit the search method and search index used. Calculates the size of the current search indexes in use. Allows to create and delete a fulltext index on the messages table. Allows to delete a custom index (that CreateMessageIndex() created). Called by ?action=admin;area=managesearch;sa=method. Requires the admin_forum permission.

EditSearchSettings

Edit some general settings related to the search function. Called by ?action=admin;area=managesearch;sa=settings. Requires the admin_forum permission.

EditSmileyOrder Allows to edit smileys order.
EditSmileys Add, remove, edit smileys.
EditSmileySets List, add, remove, modify smileys sets.
EditSmileySettings Handles modifying smileys settings.
EditSpider Here we can add, and edit, spider info!
EditTask Function for editing a task.
EditTheme

Shows an interface for editing the templates. - uses the Themes template and edit_template/edit_style sub template. - accessed via ?action=admin;area=theme;sa=edit

EditWeights

Edit the relative weight of the search factors. Called by ?action=admin;area=managesearch;sa=weights. Requires the admin_forum permission.

emailAdmins

Send all the administrators a lovely email. - loads all users who are admins or have the admin forum permission. - uses the email template and replacements passed in the parameters. - sends them an email.

EnableTheme Handles enabling/disabling a theme from the admin center
entity_fix__callback Strips out invalid html entities, replaces others with html style { codes
escapestring__recursive

Adds slashes to the array/variable. What it does: - returns the var, as an array or string, with escapes as required. - importantly escapes all keys and values! - calls itself recursively if necessary.

ExamineFile Display one of the files in a package.
expandIPv6 Expands a IPv6 address to its full form.
fatal_error

An irrecoverable error. This function stops execution and displays an error message. It logs the error message if $log is specified.

fatal_lang_error Shows a fatal error with a message stored in the language file.
fetch_alerts Fetch the alerts a member currently has.
fetch_task The heart of this cron handler...
fetch_web_data Get the contents of a URL, irrespective of allow_url_fopen.
fetchPerms__recursive Checkes the permissions of all the areas that will be affected by the package
fetchTagAttributes Returns an array of attributes associated with a tag.
find_gpg
find_signed_off
find_signed_off_parents
findForumErrors

Checks for errors in steps, until 5 seconds have passed. It keeps track of the errors it did find, so that the actual repair won't have to recheck everything.

findMembers

Finds members by email address, username, or real name. - searches for members whose username, display name, or e-mail address match the given pattern of array names. - searches only buddies if buddies_only is set.

findSearchAPI Creates a search API and returns the object.
finishTables

This does the necessary count of table data before displaying them. is (unfortunately) required to create some useful variables for templates. foreach data table created, it will count the number of rows and columns in the table. will also create a max_width variable for the table, to give an estimate width for the whole table * * if it can.

fix_possible_url

Called from dumpTags to convert data to xml Finds urls for local site and sanitizes them

fix_serialized_data Attempts to repair corrupted serialized data strings
fixchar__callback Converts html entities to utf8 equivalents
fixchardb__callback

Converts html entities to utf8 equivalents special db wrapper for mysql based on the limitation of mysql/mb3

fixChildren

Fixes the children of a board by setting their child_levels to new values. Used when a board is deleted or moved, to affect its children.

fixModSecurity
fixRelativePath
fixTag

Fix a specific class of tag - ie. url with =. Used by fixTags, fixes a specific tag's links.

fixTags

Fix any URLs posted - ie. remove 'javascript:'. Used by preparsecode, fixes links in message and returns nothing.

forum_time Gets the current time with offset.
forumProfile Handles the main "Forum Profile" section of the profile
ForumSettings
frameOptionsHeader This sets the X-Frame-Options header.
GeneralPermissionSettings A screen to set some general settings for permissions.
generateSubscriptionError Log an error then exit
generateValidationCode Generate a random validation code.
get_all_themes Loads and returns all installed themes.
get_current_settings Retrieves a copy of the current values of all settings defined in Settings.php.
get_date_or_time_format Gets a version of a strftime() format that only shows the date or time components
get_directory_tree_elements Split a path into a list of all directories and subdirectories
get_file_listing Generates a file listing for a given directory
get_files_recursive Gets all of the files in a directory and its children directories
get_gravatar_url

Return a Gravatar URL based on - the supplied email address, - the global maximum rating, - the global default fallback, - maximum sizes as set in the admin panel.

get_hook_info_from_raw Parses each hook data and returns an array.
get_installed_themes Loads and returns all installed themes.
get_integration_hooks Parses modSettings to create integration hook array
get_integration_hooks_count

Simply returns the total count of integration hooks Used by the integration hooks list function (list_integration_hooks)

get_integration_hooks_data

Callback function for the integration hooks list (list_integration_hooks) Gets all of the hooks in the system and their status

get_proxied_url Gets the appropriate URL to use for images (or whatever) when using SSL
get_single_theme Gets a single theme's info.
get_theme_info Reads an .xml file and returns the data as an array
getAttachmentFilename Get an attachment's encrypted filename. If $new is true, won't check for file existence.
getAttachMsgInfo Gets all needed message data associated with an attach ID
getAvatars Recursive function to retrieve server-stored avatar files
getBirthdayRange

Get all birthdays within the given time range. finds all the birthdays in the specified range of days. works with birthdays set for no year, or any other year, and respects month and year boundaries.

getBoardIndex

Fetches a list of boards and (optional) categories including statistical information, child boards and moderators. - Used by both the board index (main data) and the message index (child boards). - Depending on the include_categories setting returns an associative array with categories->boards->child_boards or an associative array with boards->child_boards.

getBoardList

Generates the query to determine the list of available boards for a user Executes the query and returns the list

getBoardModeratorGroups Returns board's moderator groups with their names and link
getBoardModerators Returns the given board's moderators, with their names and links
getBoardParents

Get all parent boards (requires first parent as parameter) It finds all the parents of id_parent, and that board itself. Additionally, it detects the moderators of said boards.

getBoardTree

Load a lot of useful information regarding the boards and categories. The information retrieved is stored in globals: $boards properties of each board. $boardList a list of boards grouped by category ID. $cat_tree properties of each category.

getCalendarGrid Provides information (link, month, year) about the previous and next month.
getCalendarList Returns the information needed to show a list of upcoming events, birthdays, and holidays on the calendar.
getCalendarWeek Returns the information needed to show a calendar for the given week.
getCommentModDetails

Gets specific details about a moderator comment. It also adds a permission for editing/deleting the comment, by default only admins and the author of the comment can edit/delete it.

getCustFieldsMList Sets the label, sort and join info for every custom field column.
getDailyStats

Loads the statistics on a daily basis in $context. called by DisplayStats().

getEventPoster Get the event's poster.
getEventProperties Gets all the events properties
getEventRange Get all calendar events within the given time range.
getFileVersions

Search through source, theme and language files to determine their version. Get detailed version information about the physical SMF files on the server.

getHolidayRange Get all holidays within the given time range.
GetJumpTo Get a list of boards and categories used for the jumpto dropdown.
getLanguages

Attempt to reload our known languages. It will try to choose only utf8 or non-utf8 languages.

getLastPost Get the latest post made on the system
getLastPosts Get the latest posts of a forum.
GetMemberActivationCounts Fetches all the activation counts for ViewMembers.
getMemberData Gets basic member data for the ban
getMemberGroups Returns a list of member groups. Used to upgrade 1.0 and 1.1.
getMembersOnlineStats

Retrieve a list and several other statistics of the users currently online. Used by the board index and SSI. Also returns the membergroups of the users that are currently online. (optionally) hides members that chose to hide their online presence.

getMessageIcons

Retrieves a list of message icons. - Based on the settings, the array will either contain a list of default message icons or a list of custom message icons retrieved from the database. - The board_id is needed for the custom message icons (which can be set for each board individually).

getMsgMemberID Get the id_member associated with the specified message.
getNewEventDatetimes Gets an initial set of date and time values for creating a new event.
getNotifyPrefs

Fetches the list of preferences (or a single/subset of preferences) for notifications for one or more users.

getPackageInfo

Loads a package's information and returns a representative array. - expects the file to be a package in Packages/. - returns a error string if the package-info is invalid. - otherwise returns a basic array of id, version, filename, and similar information. - an xmlArray is available in 'xml'.

getRawAttachInfo Gets raw info directly from the attachments table.
getReportComments Gets both report comments as well as any moderator comment.
getReportDetails Gets additional information for a specific report.
getReports Get all possible reports the current user can see.
getServerVersions Get a list of versions that are currently installed on the server.
getTodayInfo

Returns date information about 'today' relative to the users time offset. returns an array with the current date, day, month, and year. takes the users time offset into account.

getTopic Get the topic for display purposes.
getTreeOrder

Tries to load up the entire board order and category very very quickly Returns an array with two elements, cats and boards

getUserTimezone Gets a member's selected timezone identifier directly from the database
getXmlMembers

Retrieve the list of members from database. The array will be generated to match the format.

getXmlNews

Get the latest topics information from a specific board, to display later. The returned array will be generated to match the xml_format.

getXmlProfile

Get the profile information for member into an array, which will be generated to match the xml_format.

getXmlRecent

Get the recent topics to display. The returned array will be generated to match the xml_format.

gif_outputAsPng Writes a gif file to disk as a png file.
GroupList This very simply lists the groups, nothing snazy.
groupMembership Function to allow the user to choose group membership etc...
groupMembership2 This function actually makes all the group changes
GroupPermissionsReport

Show the large variety of group permissions assigned to each membergroup. functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

GroupRequests Show and manage all group requests.
Groups

Entry point function, permission checks, admin bars, etc. It allows moderators and users to access the group showing functions. It handles permission checks, and puts the moderation bar on as required.

groupsAllowedTo

Retrieves a list of membergroups that are allowed to do the given permission. (on the given board) If board_id is not null, a board permission is assumed. The function takes different permission settings into account.

HandleComment Creates/Deletes moderator comments.
HandleReport Performs closing/ignoring actions for a given report.
hash_benchmark Benchmarks the server to figure out an appropriate cost factor (minimum 9)
hash_length Returns the length for current hash
hash_password Hashes username with password
hash_salt Hashes password with salt, this is solely used for cookies.
hash_verify_password Verifies a raw SMF password against the bcrypt'd string
HelpIndex The main page for the Help section
HelpRules Displays forum rules
highlight Highlighting matching string
highlight_php_code Highlight any code.
host_from_ip Lookup an IP; try shell_exec first because we can do a timeout on it.
html_to_bbc

Converts HTML to BBC As of SMF 2.1, only used by ManageBoards.php (and possibly mods)

htmlspecialchars__recursive

Adds html entities to the array/variable. Uses two underscores to guard against overloading. What it does: - adds entities (", <, >) to the array or string var. - importantly, does not effect keys, only values. - calls itself recursively if necessary.

htmltrim__recursive

Trim a string including the HTML space, character 160. Uses two underscores to guard against overloading. What it does: - trims a string or an the var array using html characters as well. - does not effect keys, only values. - may call itself recursively if needed.

https_redirect_active Check if the passed url has a redirect to https:// by querying headers.
httpsOn Check if the connection is using https.
iCalDownload This function offers up a download of an event in iCal 2.0 format.
ignoreboards Handles the "ignored boards" section of the profile (if enabled)
imagecopyresamplebicubic

Copy image. Used when imagecopyresample() is not available.

imagecreatefrombmp

It is set only if it doesn't already exist (for forwards compatiblity.) It only supports uncompressed bitmaps.

imageMemoryCheck See if we have enough memory to thumbnail an image
ImportSmileys A function to import new smileys from an existing directory into the database.
inet_dtop
inet_ptod
initialize_inputs
InMaintenance

Display a message about the forum being in maintenance mode. - display a login screen with sub template 'maintenance'. - sends a 503 header, so search engines don't bother indexing while we're in maintenance mode.

insertBanGroup

Creates a new ban group If the group is successfully created the ID is returned On error the error code is returned or false

insertEvent

Consolidating the various INSERT statements into this function. Inserts the passed event information into the calendar table. Allows to either set a time span (in days) or an end_date. Does not check any permissions of any sort.

InstallCopy Makes a copy from the default theme, assigns a name for it and installs it.
InstallDir Install a theme from a specific dir
installer_updateSettingsFile
installExit
InstallFile Installs a theme from a theme package.
InstallSmileySet Install a smiley set.
ip2range

Convert a single IP to a ranged IP. internal function used to convert a user-readable format to a format suitable for the database.

iri_to_url Converts a URL with international characters (an IRI) into a pure ASCII URL
is_not_banned

Do banning related stuff. (ie. disallow access....) Checks if the user is banned, and if so dies with an error. Caches this information for optimization purposes.

is_not_guest

Require a user who is logged in. (not a guest.) Checks if the user is currently a guest, and if so asks them to login with a message telling them why. Message is what to tell them when asking them to login.

isAccessiblePM Check if the PM is available to the current user.
isAllowedTo

Fatal error if they cannot. Uses allowedTo() to check if the user is allowed to do permission. Checks the passed boards or current board for the permission. If $any is true, the user only needs permission on at least one of the boards to pass If they are not, it loads the Errors language file and shows an error using $txt['cannot_' . $permission]. If they are a guest and cannot do it, this calls is_not_guest().

isBannedEmail

Checks if a given email address might be banned. Check if a given email is banned. Performs an immediate ban if the turns turns out positive.

isBrowser Are we using this browser?
isChildOf Returns whether the child board id is actually a child of the parent (recursive).
isReservedName

Check if a name is in the reserved words list. (name, current member id, name/username?.) - checks if name is a reserved name or username. - if is_name is false, the name is assumed to be a username. - the id_member variable is used to ignore duplicate matches with the current member.

issueWarning Issue/manage an user's warning status.
isValidIP

Check the given String if he is a valid IPv4 or IPv6 return true or false

isValidIPv6 Validates a IPv6 address. returns true if it is ipv6.
JavaScriptEscape Escapes (replaces) characters in strings to make them safe for use in javascript
JavaScriptModify

Used to edit the body or subject of a message inline called from action=jsmodify from script and topic js

jeffsdatediff

Nifty function to calculate the number of days ago a given date was. Requires a unix timestamp as input, returns an integer. Named in honour of Jeff Lewis, the original creator of...this function.

JSMembers

Called by index.php?action=findmember. - is used as a popup for searching members. - uses sub template find_members of the Help template. - also used to add members for PM's sent using wap2/imode protocol.

KickGuest

Throws guests out to the login screen when guest access is off. - sets $_SESSION['login_url'] to $_SERVER['REQUEST_URL']. - uses the 'kick_guest' sub template found in Login.template.php.

legalise_bbc Attempt to clean up illegal BBC caused by browsers like Opera which don't obey the rules
list_getAttachDirs Prepare the actual attachment directories to be displayed in the list.
list_getAttachments Get a list of attachments for a member. Callback for the list in showAttachments()
list_getBanItems Retrieves all the ban items belonging to a certain ban group
list_getBanLogEntries

Load a list of ban log entries from the database. (no permissions check). Callback for $listOptions['get_items'] in BanLog()

list_getBans Get bans, what else? For the given options.
list_getBanTriggers Get ban triggers for the given parameters. Callback from $listOptions['get_items'] in BanBrowseTriggers()
list_getBaseDirs Prepare the base directories to be displayed in a list.
list_getBoardNotifications Gets information about all the boards a user has requested notifications for. Callback for the list in alert_notifications_boards
list_getFiles

Returns the list of attachments files (avatars or not), recorded in the database, per the parameters received.

list_getGroupRequestCount Callback function for createList().
list_getGroupRequests
list_getGroupRequestsCount How many edits?
list_getHolidays Gets all of the holidays for the listing
list_getIPMessageCount Gets the number of posts made from a particular IP
list_getIPMessages Gets all the posts made from a particular IP
list_getLanguages

Fetch the actual language information. Callback for $listOptions['get_items']['function'] in ManageLanguageSettings. Determines which languages are available by looking for the "index.{language}.php" file. Also figures out how many users are using a particular language.

list_getLanguagesList

Gets a list of available languages from the mother ship Will return a subset if searching, otherwise all avaialble

list_getLoginCount Finds the total number of tracked logins for a particular user
list_getLogins Callback for the list in trackLogins.
list_getMailQueue

This function grabs the mail queue items from the database, according to the params given. Callback for $listOptions['get_items'] in BrowseMailQueue()

list_getMailQueueSize

Returns the total count of items in the mail queue. Callback for $listOptions['get_count'] in BrowseMailQueue

list_getMembergroups Helper function to generate a list of membergroups for display
list_getMembers Callback for createList().
list_getMessageIcons Callback function for createList().
list_getModLogEntries

Gets the moderation log entries that match the specified parameters. Callback for createList() in ViewModlog().

list_getModLogEntryCount

Get the number of mod log entries. Callback for createList() in ViewModlog().

list_getNews Prepares an array of the forum news items for display in the template
list_getNumAttachments Gets the total number of attachments for a member
list_getNumBanItems Gets the number of ban items belonging to a certain ban group
list_getNumBanLogEntries This returns the total count of ban log entries. Callback for $listOptions['get_count'] in BanLog().
list_getNumBans Get the total number of ban from the ban group table
list_getNumBanTriggers This returns the total number of ban triggers of the given type. Callback for $listOptions['get_count'] in BanBrowseTriggers().
list_getNumFiles

Return the number of files of the specified type recorded in the database. (the specified type being attachments or avatars).

list_getNumHolidays Helper function to get the total number of holidays
list_getNumLanguages

How many languages? Callback for the list in ManageLanguageSettings().

list_getNumMembers Callback for createList().
list_getNumSmileys Callback function for createList().
list_getNumSmileySets Callback function for createList().
list_getNumSpiderLogs Callback function for createList()
list_getNumSpiders Callback function for createList()
list_getNumSpiderStats

Callback function for createList() Get the number of spider stat rows from the log spider stats table

list_getNumTaskLogEntries Callback function for createList() in TaskLog().
list_getNumUnapprovedAttachments

Callback function for UnapprovedAttachments count all the attachments waiting for approval that this approver can approve

list_getNumUnwatched Count the number of topics in the unwatched list
list_getPackages Get a listing of all the packages
list_getProfileEditCount How many edits?
list_getProfileEdits Loads up information about a user's profile edits. Callback for the list in trackEdits()
list_getProfileFields Callback for createList().
list_getProfileFieldSize Callback for createList().
list_getScheduledTasks Callback function for createList() in ScheduledTasks().
list_getSmileys Callback function for createList().
list_getSmileySets Callback function for createList().
list_getSpiderLogs Callback function for createList()
list_getSpiders Callback function for createList()
list_getSpiderStats

Callback function for createList() Get a list of spider stats from the log_spider table

list_getSubscribedUserCount Returns how many people are subscribed to a paid subscription.
list_getSubscribedUsers Return the subscribed users list, for the given parameters.
list_getTaskLogEntries Callback function for createList() in TaskLog().
list_getTopicNotificationCount Determins how many topics a user has requested notifications for
list_getTopicNotifications Gets information about all the topics a user has requested notifications for. Callback for the list in alert_notifications_topics
list_getUnapprovedAttachments

Callback function for UnapprovedAttachments retrieve all the attachments waiting for approval the approver can approve

list_getUnwatched Gets information about unwatched (disregarded) topics. Callback for the list in show_unwatched
list_getUserErrorCount Get the number of user errors
list_getUserErrors Gets all of the errors generated by a user's actions. Callback for the list in track_activity
list_getUserWarningCount Get the number of warnings a user has. Callback for $listOptions['get_count'] in issueWarning()
list_getUserWarnings Get the data about a user's warnings. Callback function for the list in issueWarning()
list_getWarningCount Callback for createList().
list_getWarnings Callback for createList().
list_getWarningTemplateCount Callback for createList().
list_getWarningTemplates Callback for createList().
list_getWatchedUserCount Callback for createList().
list_getWatchedUserPosts Callback for createList().
list_getWatchedUserPostsCount Callback for createList().
list_getWatchedUsers Callback for createList().
list_integration_hooks

Generates a list of integration hooks for display Accessed through ?action=admin;area=maintain;sa=hooks; Allows for removal or disabling of selected hooks

listMembergroupMembers_Href

Gets the members of a supplied membergroup Returns them as a link for display

ListMessageIcons Gets a list of available message icons and sends the info to the template for display
listtree Create a tree listing for a given directory path
load_database
load_file

Receives a string and tries to figure it out if it contains info to load a file. Checks for a | (pipe) symbol and tries to load a file with the info given. The string should be format as follows File.php|. You can use the following wildcards: $boarddir, $sourcedir and if available at the moment of execution, $themedir.

load_lang_file
loadAttachmentContext

This loads an attachment's contextual data including, most importantly, its size if it is an image. It requires the view_attachments permission to calculate image size. It attempts to keep the "aspect ratio" of the posted image in line, even if it has to be resized by the max_image_width and max_image_height settings.

loadBoard

Check for moderators and see if they have access to the board. What it does: - sets up the $board_info array for current board information. - if cache is enabled, the $board_info array is stored in cache. - redirects to appropriate post if only message id is requested. - is only used when inside a topic or board. - determines the local moderators for the board. - adds group id 3 if the user is a local moderator for the board they are in. - prevents access if user is not in proper group nor a local moderator of the board.

loadCacheAccelerator Try to load up a supported caching method. This is saved in $cacheAPI if we are not overriding it.
loadCacheAPIs Get the installed Cache API implementations.
loadCSSFile Add a CSS file for output later
loadCustomFields Load any custom fields for this area... no area means load all, 'summary' loads all public ones.
loadDatabase Initialize a database connection.
loadDatePair Loads the necessary JavaScript for Datepair.js.
loadDatePicker Loads the necessary JavaScript and CSS to create a datepicker.
loadEmailTemplate Load a template from EmailTemplates language file.
loadEssentialData
loadEssentialThemeData This loads the bare minimum data to allow us to load language files!
loadForumTests Load up all the tests we might want to do ;)
loadGeneralSettingParameters This function makes sure the requested subaction does exists, if it doesn't, it sets a default action or.
loadIllegalBBCHtmlGroups

Loads a list of membergroups who cannot be granted the bbc_html permission. Stores the groups in $context['permissions_excluded']['bbc_html'].

loadIllegalGuestPermissions

Loads the permissions that can not be given to guests. Stores the permissions in $context['non_guest_permissions']. Also populates $context['permissions_excluded'] with the info.

loadIllegalPermissions Load permissions someone cannot grant.
loadInstalledPackages Loads and returns an array of installed packages.
loadJavaScriptFile Add a Javascript file for output later
loadLanguage Load a language file. Tries the current and default themes as well as the user and global languages.
loadLocale Creates the javascript code for localization of the editor (SCEditor)
loadMemberContext Loads the user's basic values... meant for template/theme usage.
loadMemberCustomFields Loads the user's custom profile fields
loadMemberData Loads an array of users' data by ID or member_name.
loadPaymentGateways

Load all the payment gateways. Checks the Sources directory for any files fitting the format of a payment gateway, loads each file to check it's valid, includes each file and returns the function name and whether it should work with this version of SMF.

loadPermissionProfiles Load permissions profiles.
loadPermissions Load this user's permissions.
loadProfileFields This defines every profile field known to man.
LoadRules Load up all the rules for the current user.
loadSearchAPIs

Get the installed Search API implementations. This function checks for patterns in comments on top of the Search-API files! In addition to filenames pattern. It loads the search API classes if identified. This function is used by EditSearchMethod to list all installed API implementations.

loadSession Attempt to start the session, unless it already has been.
loadSubscriptions This just kind of caches all the subscription data.
loadSubTemplate

Load a sub-template. What it does: - loads the sub template specified by sub_template_name, which must be in an already-loaded template. - if ?debug is in the query string, shows administrators a marker after every sub template for debugging purposes.

loadTemplate

Load a template - if the theme doesn't include it, use the default. What this function does: - loads a template file with the name template_name from the current, default, or base theme. - detects a wrong default theme directory and tries to work around it.

loadTheme Load a theme, by ID.
loadThemeOptions Loads the theme options for a user
loadTimePicker Loads the necessary JavaScript and CSS to create a timepicker.
loadUserSettings

Load all the important user information. What it does: - sets up the $user_info array - assigns $user_info['query_wanna_see_board'] for what boards the user can see. - first checks for cookie or integration validation. - uses the current session if no integration function or cookie is found. - checks password length, if member is activated and the login span isn't over. - if validation fails for the user, $id_member is set to 0. - updates the last visit time when needed.

LockTopic

Locks a topic... either by way of a moderator or the topic starter. What this does: - locks a topic, toggles between locked/unlocked/admin locked. - only admins can unlock topics locked by other admins. - requires the lock_own or lock_any permission. - logs the action to the moderator log. - returns to the topic after it is done. - it is accessed via ?action=lock.

LockVoting

Lock the voting for a poll. Must be called with a topic specified in the URL. An admin always has over riding permission to lock a poll. If not an admin must have poll_lock_any permission, otherwise must be poll starter with poll_lock_own permission. Upon successful completion of action will direct user back to topic. Accessed via ?action=lockvoting.

log_ban

Log a ban in the database. Log the current user in the ban logs. Increment the hit counters for the specified ban ID's (if any.)

log_error

Log an error, if the error logging is enabled. filename and line should be FILE and LINE, respectively. Example use: die(log_error($msg));

log_error_online

Small utility function for fatal error pages. Used by fatal_error(), fatal_lang_error()

logAction

This function logs an action in the respective log. (database log) You should use logActions() instead.

logActions

Log changes to the forum, such as moderation events or administrative changes. This behaves just like logAction() in SMF 2.0, except that it is designed to log multiple actions at once.

Login

Ask them for their login information. (shows a page for the user to type in their username and password.) It caches the referring URL in $_SESSION['login_url']. It is accessed from ?action=login.

Login2

Actually logs you in. What it does: - checks credentials and checks that login was successful. - it employs protection against a specific IP or user trying to brute force a login to an account. - upgrades password encryption on login, if necessary. - after successful login, redirects you to $_SESSION['login_url']. - accessed from ?action=login2, by forms. On error, uses the same templates Login() uses.

LoginTFA Allows the user to enter their Two-Factor Authentication code
logLastDatabaseError

Logs the last database error into a file. Attempts to use the backup file first, to store the last database error and only update db_last_error.php if the first was successful.

Logout

Logs the current user out of their account. It requires that the session hash is sent as well, to prevent automatic logouts by images or javascript. It redirects back to $_SESSION['logout_url'], if it exists. It is accessed via ?action=logout;session_var=...

logSpider Log the spider presence online.
logTriggersUpdates A small function to unify logging of triggers (updates and new)
MaintainCleanCache

Wipes the whole cache directory. This only applies to SMF's own cache directory, though.

MaintainDatabase Supporting function for the database maintenance area.
MaintainEmptyUnimportantLogs Empties all uninmportant logs
MaintainFiles

Show several file maintenance options. Called by ?action=admin;area=manageattachments;sa=maintain. Calculates file statistics (total file size, number of attachments, number of avatars, attachment space available).

MaintainFindFixErrors Find and fix all errors on the forum.
MaintainMassMoveTopics Moves topics from one board to another.
MaintainMembers Supporting function for the members maintenance area.
MaintainPurgeInactiveMembers Removing old members. Done and out!
MaintainReattributePosts Re-attribute posts.
MaintainRecountPosts

Recalculate all members post counts it requires the admin_forum permission.

MaintainRemoveOldDrafts Removing old drafts
MaintainRemoveOldPosts Removing old posts doesn't take much as we really pass through.
MaintainRoutine Supporting function for the routine maintenance area.
MaintainTopics Supporting function for the topics maintenance area.
makeCustomFieldChanges Save any changes to the custom profile fields
makeFilesWritable Make files writable. First try to use regular chmod, but if that fails, try to use FTP.
makeNotificationChanges Make any notification changes that need to be made.
makeThemeChanges Make any theme changes that are sent with the profile.
ManageAttachmentPaths This function lists and allows updating of multiple attachments paths.
ManageAttachments

The main 'Attachments and Avatars' management function. This function is the entry point for index.php?action=admin;area=manageattachments and it calls a function based on the sub-action. It requires the manage_attachments permission.

ManageAttachmentSettings

Allows to show/change attachment settings. This is the default sub-action of the 'Attachments and Avatars' center. Called by index.php?action=admin;area=manageattachments;sa=attachments.

ManageAvatarSettings

This allows to show/change avatar settings. Called by index.php?action=admin;area=manageattachments;sa=avatars. Show/set permissions for permissions: 'profile_server_avatar', 'profile_upload_avatar' and 'profile_remote_avatar'.

ManageBoards

The main dispatcher; doesn't do anything, just delegates. This is the main entry point for all the manageboards admin screens. Called by ?action=admin;area=manageboards. It checks the permissions, based on the sub-action, and calls a function based on the sub-action.

ManageBoardsMain

The main control panel thing, the screen showing all boards and categories. Called by ?action=admin;area=manageboards or ?action=admin;area=manageboards;sa=move. Requires manage_boards permission. It also handles the interface for moving boards.

ManageCalendar

The main controlling function doesn't have much to do... yet. Just check permissions and delegate to the rest.

ManageLabels This function handles adding, deleting and editing labels on messages.
ManageLanguages

This is the main function for the languages area. It dispatches the requests. Loads the ManageLanguages template. (sub-actions will use it)

ManageMail Main dispatcher. This function checks permissions and passes control through to the relevant section.
ManageMaintenance

Main dispatcher, the maintenance access point. This, as usual, checks permissions, loads language files, and forwards to the actual workers.

ManageNews

The news dispatcher; doesn't do anything, just delegates. This is the entrance point for all News and Newsletter screens. Called by ?action=admin;area=news. It does the permission checks, and calls the appropriate function based on the requested sub-action.

ManagePaidSubscriptions

The main entrance point for the 'Paid Subscription' screen, calling the right function based on the given sub-action. It defaults to sub-action 'view'. Accessed from ?action=admin;area=paidsubscribe. It requires admin_forum permission for admin based actions.

ManagePostSettings

The main entrance point for the 'Posts and topics' screen. Like all others, it checks permissions, then forwards to the right function based on the given sub-action. Defaults to sub-action 'posts'. Accessed from ?action=admin;area=postsettings. Requires (and checks for) the admin_forum permission.

ManageRules List all rules, and allow adding/entering etc...
ManageScheduledTasks

Scheduled tasks management dispatcher. This function checks permissions and delegates to the appropriate function based on the sub-action. Everything here requires admin_forum permission.

ManageSearch

Main entry point for the admin search settings screen. It checks permissions, and it forwards to the appropriate function based on the given sub-action. Defaults to sub-action 'settings'. Called by ?action=admin;area=managesearch. Requires the admin_forum permission.

ManageSearchEngineSettings This is really just the settings page.
ManageSmileys This is the dispatcher of smileys administration.
markBoardsRead Mark a board or multiple boards read.
markMessages Mark the specified personal messages read.
MarkRead Mark one or more boards as read.
matchHighestPackageVersion

Checks if version matches any of the versions in versions. - supports comma separated version numbers, with or without whitespace. - supports lower and upper bounds. (1.0-1.2) - returns true if the version matched.

matchIPtoCIDR

Detect if a IP is in a CIDR address - returns true or false

matchPackageVersion

Checks if the forum version matches any of the available versions from the package install xml. - supports comma separated version numbers, with or without whitespace. - supports lower and upper bounds. (1.0-1.2) - returns true if the version matched.

md5_hmac MD5 Encryption used for older passwords. (SMF 1.0.x/YaBB SE 1.5.x hashing)
MembergroupIndex

Shows an overview of the current membergroups. Called by ?action=admin;area=membergroups. Requires the manage_membergroups permission. Splits the membergroups in regular ones and post count based groups. It also counts the number of members part of each membergroup.

MembergroupMembers

Display members of a group, and allow adding of members to a group. Silly function name though ;) It can be called from ManageMembergroups if it needs templating within the admin environment. It shows a list of members that are part of a given membergroup. It is called by ?action=moderate;area=viewgroups;sa=members;group=x It requires the manage_membergroups permission. It allows to add and remove members from the selected membergroup. It allows sorting on several columns. It redirects to itself.

MemberGroupsReport

Show what the membergroups are made of. functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

Memberlist

Shows a listing of registered members. - If a subaction is not specified, lists all registered members. - It allows searching for members with the 'search' sub action. - It calls MLAll or MLSearch depending on the sub action. - Requires the view_mlist permission. - Accessed via ?action=mlist.

membersAllowedTo

Retrieves a list of members that have a given permission (on a given board). If board_id is not null, a board permission is assumed. Takes different permission settings into account. Takes possible moderators (on board 'board_id') into account.

MembersAwaitingActivation

List all members who are awaiting approval / activation, sortable on different columns. It allows instant approval or activation of (a selection of) members. Called by ?action=admin;area=viewmembers;sa=browse;type=approve or ?action=admin;area=viewmembers;sa=browse;type=activate. The form submits to ?action=admin;area=viewmembers;sa=approve. Requires the moderate_forum permission.

memoryReturnBytes Helper function to convert memory string settings to bytes
MergeDone

Shows a 'merge completed' screen. is accessed with ?action=mergetopics;sa=done. uses 'merge_done' sub template of the SplitTopics template.

MergeExecute set merge options and do the actual merge of two or more topics.
MergeIndex

allows to pick a topic to merge the current topic with. is accessed with ?action=mergetopics;sa=index default sub action for ?action=mergetopics. uses 'merge' sub template of the MoveTopic template. allows to set a different target board.

mergePosts Take a load of messages from one place and stick them in a topic
MergeTopics

merges two or more topics into one topic. delegates to the other functions (based on the URL parameter sa). loads the SplitTopics template. requires the merge_any permission. is accessed with ?action=mergetopics.

MessageActionsApply This function performs all additional stuff...
MessageDrafts This function allows the user to view their PM drafts
MessageFolder A folder, ie. inbox/sent etc.
MessageIndex Show the list of topics in this board, along with any child boards.
messageIndexBar A menu to easily access different areas of the PM section
MessageKillAll Delete ALL the messages!
MessageMain This helps organize things...
MessagePopup The popup for when we ask for the popup from the user.
MessagePost Send a new message?
MessagePost2 Send it!
messagePostError An error in the message...
MessagePrune This function allows the user to delete all messages older than so many days.
MessageSearch Allows searching through personal messages.
MessageSearch2 Actually do the search of personal messages.
MessageSettings Allows to edit Personal Message Settings.
mimespecialchars

Prepare text strings for sending as email body or header. In case there are higher ASCII characters in the given string, this function will attempt the transport method 'quoted-printable'. Otherwise the transport method '7bit' is used.

mktree

Creates the specified tree structure with the mode specified. creates every directory in path until it finds one that already exists.

MLAll

List all members, page by page, with sorting. Called from MemberList(). Can be passed a sort parameter, to order the display of members. Calls printMemberListRows to retrieve the results of the query.

MLSearch

Search for members, or display search results. - Called by MemberList(). - If variable 'search' is empty displays search dialog box, using the search sub template. - Calls printMemberListRows to retrieve the results of the query.

ModBlockGroupRequests Show a list of all the group requests they can see.
ModBlockNotes Show an area for the moderator to type into.
ModBlockReportedMembers Show a list of the most recent reported posts.
ModBlockReportedPosts Show a list of the most recent reported posts.
ModBlockWatchedUsers Show a list of the most active watched users.
ModEndSession This ends a moderator session, requiring authentication to access the MCP again.
ModerateGroups Act as an entrace for all group related activity.
ModerationHome This function basically is the home page of the moderation center.
ModerationMain Entry point for the moderation center.
ModerationSettings Change moderation preferences.
ModifyAlertsSettings Handles modifying the alerts settings
ModifyAntispamSettings Let's try keep the spam to a minimum ah Thantos?
ModifyBasicSettings

Config array for changing the basic forum settings Accessed from ?action=admin;area=featuresettings;sa=basic;

ModifyBBCSettings

Set a few Bulletin Board Code settings. It loads a list of Bulletin Board Code tags to allow disabling tags. Requires the admin_forum permission. Accessed from ?action=admin;area=featuresettings;sa=bbc.

modifyBoard

Modify the settings and position of a board. Used by ManageBoards.php to change the settings of a board.

ModifyCacheSettings Simply modifying cache functions
ModifyCalendarSettings Show and allow to modify calendar settings. Obviously.
ModifyCat Used to retrieve data for modifying a board category
modifyCategory

Edit the position and properties of a category. general function to modify the settings and position of a category. used by ManageBoards.php to change the settings of a category.

ModifyCookieSettings This function handles cookies settings modifications.
ModifyDatabaseSettings Basic database and paths settings - database name, host, etc.
ModifyDraftSettings

Modify any setting related to drafts. Requires the admin_forum permission. Accessed from ?action=admin;area=postsettings;sa=drafts

modifyEvent

modifies an event. allows to either set a time span (in days) or an end_date. does not check any permissions of any sort.

ModifyFeatureSettings This function passes control through to the relevant tab.
ModifyGeneralModSettings If you have a general mod setting to add stick it here.
ModifyGeneralSecuritySettings Settings really associated with general security aspects.
ModifyGeneralSettings

General forum settings - forum name, maintenance mode, etc. Practically, this shows an interface for the settings in Settings.php to be changed.

ModifyHolidays The function that handles adding, and deleting holiday data
ModifyLanguage Edit a particular set of language entries.
ModifyLanguages This lists all the current languages and allows editing of them.
ModifyLanguageSettings Edit language related settings.
ModifyLayoutSettings

Allows modifying the global layout settings in the forum Accessed through ?action=admin;area=featuresettings;sa=layout;

ModifyLikesSettings

Config array for changing like settings Accessed from ?action=admin;area=featuresettings;sa=likes;

ModifyLoadBalancingSettings Allows to edit load balancing settings.
ModifyLogSettings Allow to edit the settings on the pruning screen.
ModifyMailSettings Allows to view and modify the mail settings.
ModifyMembergroup Initializes the necessary to modify a membergroup's permissions.
ModifyMembergroup2 This function actually saves modifications to a membergroup's board permissions.
ModifyMembergroups

Main dispatcher, the entrance point for all 'Manage Membergroup' actions. It forwards to a function based on the given subaction, default being subaction 'index', or, without manage_membergroup permissions, then 'settings'. Called by ?action=admin;area=membergroups. Requires the manage_membergroups or the admin_forum permission.

ModifyMembergroupsettings

Set some general membergroup settings and permissions. Called by ?action=admin;area=membergroups;sa=settings Requires the admin_forum permission (and manage_permissions for changing permissions) Redirects to itself.

ModifyMentionsSettings

Config array for changing like settings Accessed from ?action=admin;area=featuresettings;sa=mentions;

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

Set general news and newsletter settings and permissions. Called by ?action=admin;area=news;sa=settings. Requires the forum_admin permission.

ModifyPermissions

Dispatches to the right function based on the given subaction. Checks the permissions, based on the sub-action. Called by ?action=managepermissions.

modifyPost Modifying a post...
ModifyPostModeration Present a nice way of applying post moderation.
ModifyPostSettings

Modify any setting related to posts and posting. Requires the admin_forum permission. Accessed from ?action=admin;area=postsettings;sa=posts.

ModifyProfile The main designating function for modifying profiles. Loads up info, determins what to do, etc.
ModifyRegistrationSettings

This function handles registration settings, and provides a few pretty stats too while it's at it. General registration settings and Coppa compliance settings. Accessed by ?action=admin;area=regcenter;sa=settings. Requires the admin_forum permission.

ModifySettings

This is the main dispatcher. Sets up all the available sub-actions, all the tabs and selects the appropriate one based on the sub-action.

ModifySignatureSettings You'll never guess what this function does...
ModifySubscription

Adding, editing and deleting subscriptions. Accessed from ?action=admin;area=paidsubscribe;sa=modify.

ModifySubscriptionSettings

Set any setting related to paid subscriptions, i.e. modify which payment methods are to be used. It requires the moderate_forum permission Accessed from ?action=admin;area=paidsubscribe;sa=settings.

ModifyTopicSettings

Modify any setting related to topics. Requires the admin_forum permission. Accessed from ?action=admin;area=postsettings;sa=topics.

ModifyUserSubscription

Edit or add a user subscription. Accessed from ?action=admin;area=paidsubscribe;sa=modifyuser.

ModifyWarningSettings Moderation type settings - although there are fewer than we have you believe ;)
ModifyWarningTemplate Edit a warning template.
MoveTopic

This function allows to move a topic, making sure to ask the moderator to give reason for topic move. It must be called with a topic specified. (that is, global $topic must be set... @todo fix this thing.) If the member is the topic starter requires the move_own permission, otherwise the move_any permission. Accessed via ?action=movetopic.

MoveTopic2

Execute the move of a topic. It is called on the submit of MoveTopic. This function logs that topics have been moved in the moderation log. If the member is the topic starter requires the move_own permission, otherwise requires the move_any permission. Upon successful completion redirects to message index. Accessed via ?action=movetopic2.

moveTopicConcurrence Called after a topic is moved to update $board_link and $topic_link to point to new location
moveTopics

Moves one or more topics to a specific board. (doesn't check permissions.) Determines the source boards for the supplied topics Handles the moving of mark_read data Updates the posts count of the affected boards

MySQLConvertOldIp Convert MySQL (var)char ip col to binary
newsletterpreview Handles previewing newsletters
newspreview Handles previewing news items
newTable

This function creates a new table of data, most functions will only use it once. The core of this file, it creates a new, but empty, table of data in context, ready for filling using addData(). Fills the context variable current_table with the ID of the table created. Keeps track of the current table count using context variable table_count.

next_time Simply returns a time stamp of the next instance of these time parameters.
nextSubstep
notification Display the notifications and settings for changes.
ob_sessrewrite

Rewrite URLs to include the session ID. What it does: - rewrites the URLs outputted to have the session ID, if the user is not accepting cookies and is using a standard web browser. - handles rewriting URLs for the queryless URLs option. - can be turned off entirely by setting $scripturl to an empty string, ''. (it wouldn't work well like that anyway.) - because of bugs in certain builds of PHP, does not function in versions lower than 4.3.0 - please upgrade if this hurts you.

obExit Ends execution. Takes care of template loading and remembering the previous URL.
obExit_cron The exit function
OptimizeTables

Optimizes all tables in the database and lists how much was saved. It requires the admin_forum permission. It shows as the maintain_forum admin area. It is accessed from ?action=admin;area=maintain;sa=database;activity=optimize. It also updates the optimize scheduled task such that the tables are not automatically optimized again too soon.

package_chmod Try to make a file writable.
package_create_backup Creates a backup of forum files prior to modifying them
package_crypt Used to crypt the supplied ftp password in this session
package_flush_cache Flushes the cache from memory to the filesystem
package_get_contents Get the physical contents of a packages file
package_put_contents

Writes data to a file, almost exactly like the file_put_contents() function. uses FTP to create/chmod the file when necessary and available. uses text mode for text mode file extensions. returns the number of bytes written.

PackageBrowse Browse a list of installed packages.
PackageDownload Download a package.
PackageFTPTest Test an FTP connection.
PackageGBrowse Browse a server's list of packages.
PackageGet Browse the list of package servers, add servers...
PackageInstall Apply another type of (avatar, language, etc.) package.
PackageInstallTest Test install a package.
PackageList List the files in a package.
PackageOptions Used when a temp FTP access is needed to package functions
PackagePermissions Allow the admin to reset permissions on files.
PackagePermissionsAction Actually action the permission changes they want.
PackageRemove Delete a package.
packageRequireFTP Use FTP functions to work with a package download/install
Packages This is the notoriously defunct package manager..... :/.
PackageServerAdd Add a package server to the list.
PackageServerRemove Remove a server from the list.
PackageServers Load a list of package servers.
PackageUpload Upload a new package to the directory.
parse_bbc Parse bulletin board code in a string, as well as smileys optionally.
parse_path Parses special identifiers out of the specified path.
parse_sql
parseAttachBBC Gets an attach ID and tries to load all its info.
parseBoardMod Parses a boardmod-style (.mod) modification file
parseModification Parses a xml-style modification file (file).
parsePackageInfo Parses the actions in package-info.xml file from packages.
parsesmileys Parse smileys in the passed message.
password_get_info

Get information about the password hash. Returns an array of the information that was used to generate the password hash.

password_hash

Hash the password using the specified algorithm Limits the maximum length of password to 72, if a longer string is supplied the first 72 characters are used

password_needs_rehash Determine if the password hash needs to be rehashed according to the options provided
password_verify Verify a password against a hash using a timing attack resistant approach
pauseAttachmentMaintenance

Function called in-between each round of attachments and avatar repairs. Called by repairAttachments(). If repairAttachments() has more steps added, this function needs updated!

pauseMailQueueClear Used for pausing the mail queue.
pauseRepairProcess

Show the not_done template to avoid CGI timeouts and similar. Called when 3 or more seconds have passed while searching for errors. If max_substep is set, $_GET['substep'] / $max_substep is the percent done this step is.

pauseSignatureApplySettings Just pause the signature applying thing.
perform_task This actually handles the task
PermissionByBoard Handle permissions by board... more or less. :P
PermissionIndex

Sets up the permissions by membergroup index page. Called by ?action=managepermissions Creates an array of all the groups with the number of members and permissions.

permute

Calculates all the possible permutations (orders) of array. should not be called on huge arrays (bigger than like 10 elements.) returns an array containing each permutation.

php_version_check
phpBB3_password_check Custom encryption for phpBB3 based passwords.
PickTheme

Choose a theme from a list. allows a user to pick a new theme with an interface. - uses the Themes template. (pick sub template.) - accessed with ?action=theme;sa=pick.

PlushSearch1

Ask the user what they want to search for. What it does: - shows the screen to search forum posts (action=search) - uses the main sub template of the Search template. - uses the Search language file. - requires the search_posts permission. - decodes and loads search parameters given in the URL (if any). - the form redirects to index.php?action=search2.

PlushSearch2

Gather the results and show them. What it does: - checks user input and searches the messages table for messages matching the query. - requires the search_posts permission. - uses the results sub template of the Search template. - uses the Search language file. - stores the results into the search cache. - show the results of the search query.

populateDuplicateMembers Find potential duplicate registration members based on the same IP address
Post Handles showing the post screen, loading the post to be modified, and loading any post quoted.
Post2 Posts or saves the message composed with Post().
PostModerationMain This is a handling function for all things post moderation.
prepareAttachsByMsg prepare the Attachment api for all messages
prepareCLIhandler
prepareDBSettingContext Helper function, it sets up the context for database settings.
prepareDisplayContext

Callback for the message display. It actually gets and prepares the message context. This function will start over from the beginning if reset is set to true, which is useful for showing an index before or after the posts.

prepareLikesContext Prepares an array of "likes" info for the topic specified by $topic
prepareMailingForPreview

Prepare subject and message of an email for the preview box Used in ComposeMailing and RetrievePreview (Xml.php)

prepareMessageContext Get a personal message for the theme. (used to save memory.)
prepareSearchContext Callback to return messages - saves memory.
prepareServerSettingsContext

Helper function, it sets up the context for the manage server settings. - The basic usage of the six numbered key fields are - array (0 ,1, 2, 3, 4, 5 0 variable name - the name of the saved variable 1 label - the text to show on the settings page 2 saveto - file or db, where to save the variable name - value pair 3 type - type of data to save, int, float, text, check 4 size - false or field size 5 help - '' or helptxt variable name )

preparsecode

Takes a message and parses it, returning nothing. Cleans up links (javascript, etc.) and code/quote sections. Won't convert \n's and a few other things if previewing is true.

print_error Prints an error to stderr.
printMemberListRows

Retrieves results of the request passed to it Puts results of request into the context for the sub template.

PrintTopic

Format a topic to be printer friendly. Must be called with a topic specified. Accessed via ?action=printpage.

processAttachments Moves an attachment to the proper directory and set the relevant data into $_SESSION['temp_attachments']
profile_popup Set up the requirements for the profile popup - the area that is shown as the popup menu for the current user.
profileLoadAvatarData Load avatar context data.
profileLoadGroups Handles the "manage groups" section of the profile
profileLoadLanguages

Load all the languages for the profile .

profileLoadSignatureData Load key signature context data.
profileReloadUser Reload a user's settings.
profileSaveAvatarData The avatar is incredibly complicated, what with the options... and what not.
profileSaveGroups Save a members group.
profileSendActivation Send the user a new activation email if they need to reactivate!
profileValidateEmail Validate an email address.
profileValidateSignature Validate the signature
protected_alter
quickFileWritable The quick version of makeFilesWritable, which does not support FTP.
QuickInTopicModeration In-topic quick moderation.
QuickModeration Handles moderation from the message index.
QuoteFast

Loads a post an inserts it into the current editing text box. uses the Post language file. uses special (sadly browser dependent) javascript to parse entities for internationalization reasons. accessed with ?action=quotefast.

random_bytes
random_int Fetch a random integer between $min and $max inclusive
RandomCompat_intval Cast to an integer if we can, safely.
RandomCompat_strlen
RandomCompat_substr
range2ip

Convert a range of given IP number into a single string. It's practically the reverse function of ip2range().

read_tgz_data Extracts a file or files from the .tar.gz contained in data.
read_tgz_file

Reads a .tar.gz file, filename, in and extracts file(s) from it. essentially just a shortcut for read_tgz_data().

read_zip_data Extract zip data. .
read_zip_file Extract zip data. A functional copy of {@list read_zip_data()}.
ReadDraft

Reads a draft in from the user_drafts table Validates that the draft is the user''s draft Optionally loads the draft in to context or superglobal for loading in to the form

reapplySubscriptions Reapplies all subscription rules for each of the users.
reattributePosts

This function is used to reassociate members with relevant posts. Reattribute guest posts to a specified member. Does not check for any permissions. If add_to_post_count is set, the member's post count is increased.

rebuildModCache

Quickly find out what moderation authority this user has - builds the moderator, group and board level querys for the user - stores the information on the current users moderation powers in $user_info['mod_cache'] and $_SESSION['mc']

recacheSpiderNames Recache spider names?
RecentPosts Find the ten most recent posts.
recountOpenReports Recount all open reports. Sets a SESSION var with the updated info.
recursiveBoards

Recursively get a list of boards. Used by getBoardTree

redirectexit

Make sure the browser doesn't come back and repost the form data. Should be used whenever anything is posted.

redirectLocation
ReduceMailQueue Send a group of emails from the mail queue.
reencodeImage

Used to re-econodes an image to a specified image format - creates a copy of the file at the same location as fileName. - the file would have the format preferred_format if possible, otherwise the default format is jpeg. - the function makes sure that all non-essential image contents are disposed.

RegCenter

Entrance point for the registration center, it checks permissions and forwards to the right function based on the subaction. Accessed by ?action=admin;area=regcenter. Requires either the moderate_forum or the admin_forum permission.

Register Begin the registration process.
Register2 Actually register the member.
RegisterCheckUsername See if a username already exists.
registerMember

Registers a member to the forum. Allows two types of interface: 'guest' and 'admin'. The first includes hammering protection, the latter can perform the registration silently. The strings used in the options array are assumed to be escaped. Allows to perform several checks on the input, e.g. reserved names. The function will adjust member statistics. If an error is detected will fatal error on all errors unless return_errors is true.

registerSMStats

Registers the site with the Simple Machines Stat collection. This function purposely does not use updateSettings.php as it will be called shortly after this process completes by the saveSettings() function.

reloadSettings Load the $modSettings array.
RemindMe This is the controlling delegator
RemindPick Allows the user to pick how they wish to be reminded
remove_dir Removes a directory from the themes dir.
remove_integration_function

Remove an integration hook function. Removes the given function from the given hook. Does nothing if the function is not available.

remove_theme Removes a theme from the DB, includes all possible places where the theme might be used.
RemoveAllAttachments

Removes all attachments in a single click Called from the maintenance screen by ?action=admin;area=manageattachments;sa=removeall.

RemoveAttachment

Remove a selection of attachments or avatars. Called from the browse screen as submitted form by ?action=admin;area=manageattachments;sa=remove

RemoveAttachmentByAge

Remove attachments older than a given age. Called from the maintenance screen by ?action=admin;area=manageattachments;sa=byAge. It optionally adds a certain text to the messages the attachments were removed from.

RemoveAttachmentBySize

Remove attachments larger than a given size. Called from the maintenance screen by ?action=admin;area=manageattachments;sa=bySize. Optionally adds a certain text to the messages the attachments were removed from.

removeBanGroups

This function removes a bunch of ban groups based on ids Doesn't clean the inputs

removeBanLogs

Removes logs - by default truncate the table Doesn't clean the inputs

removeBanTriggers

This function removes a bunch of triggers based on ids Doesn't clean the inputs

removeDeleteConcurrence Try to determine if the topic has already been deleted by another user.
removeEvent

Remove an event removes an event. does no permission checks.

removeHolidays Remove a holiday from the calendar
removeIllegalBBCHtmlPermission Removes the bbc_html permission from anyone who shouldn't have it
removeMembersFromGroups

Remove one or more members from one or more membergroups. Requires the manage_membergroups permission. Function includes a protection against removing from implicit groups. Non-admins are not able to remove members from the admin group.

removeMessage

Remove a specific message (including permission checks). - normally, local and global should be the localCookies and globalCookies settings, respectively. - uses boardurl to determine these two things.

removeMessages Remove a batch of messages (or topics)
RemoveOldTopics2

So long as you are sure... all old posts will be gone. Used in ManageMaintenance.php to prune old topics.

RemovePoll

Remove a poll from a topic without removing the topic. Must be called with a topic specified in the URL. Requires poll_remove_any permission, unless it's the poll starter with poll_remove_own permission. Upon successful completion of action will direct user back to topic. Accessed via ?action=removepoll.

removeSubscription Removes a subscription from a user, as in removes the groups.
RemoveTheme

Remove a theme from the database. - removes an installed theme. - requires an administrator. - accessed with ?action=admin;area=theme;sa=remove.

RemoveTopic2

Completely remove an entire topic. Redirects to the board when completed.

removeTopics Removes the passed id_topic's. (permissions are NOT checked here!).
reorderBoards

Put all boards in the right order and sorts the records of the boards table. Used by modifyBoard(), deleteBoards(), modifyCategory(), and deleteCategories() functions

RepairAttachments This function should find attachments in the database that no longer exist and clear them, and fix filesize issues.
RepairBoards

Finds or repairs errors in the database to fix possible problems. Requires the admin_forum permission. Calls createSalvageArea() to create a new board, if necessary. Accessed by ?action=admin;area=repairboards.

replaceEntities__callback Decode numeric html entities to their ascii or UTF8 equivalent character.
ReportDetails

Shows detailed information about a report. such as report comments and moderator comments. Shows a list of moderation actions for the specific report.

ReportedContent

Sets and call a function based on the given subaction. Acts as a dispatcher function. It requires the moderate_forum permission.

ReportedMembers Browse all the reported users...
ReportMessage Allows the user to report a personal message to an administrator.
reportPost Actually reports a post using information specified from a form
ReportsMain

Handling function for generating reports. Requires the admin_forum permission. Loads the Reports template and language files. Decides which type of report to generate, if this isn't passed through the querystring it will set the report_type sub-template to force the user to choose which type. When generating a report chooses which sub_template to use. Depends on the cal_enabled setting, and many of the other cal_ settings. Will call the relevant report generation function. If generating report will call finishTables before returning. Accessed through ?action=admin;area=reports.

ReportToModerator

Report a post or profile to the moderator... ask for a comment. Gathers data from the user to report abuse to the moderator(s). Uses the ReportToModerator template, main sub template. Requires the report_any permission. Uses ReportToModerator2() if post data was sent. Accessed through ?action=reporttm.

ReportToModerator2

Send the emails. Sends off emails to all the moderators. Sends to administrators and global moderators. (1 and 2) Called by ReportToModerator(), and thus has the same permission and setting requirements as it does. Accessed through ?action=reporttm when posting.

reportUser Actually reports a user's profile using information specified from a form
RequestMembers

Outputs each member name on its own line. - used by javascript to find members matching the request.

resetPassword

Generates a random password for a user and emails it to them. - called by Profile.php when changing someone's username. - checks the validity of the new username. - generates and sets a new password for the given user. - mails the new password to the email address of the user. - if username is not set, only a new password is generated and sent.

resizeImage

Resizes src_img proportionally to fit within max_width and max_height limits if it is too large. If GD2 is present, it'll use it to achieve better quality. It saves the new image to destination_filename, as preferred_format if possible, default is jpeg.

resizeImageFile

Resizes an image from a remote location or a local file. Puts the resized image at the destination location. The file would have the format preferred_format if possible, otherwise the default format is jpeg.

RestoreTopic Move back a topic from the recycle board to its original board.
RetrievePreview

Handles retrieving previews of news items, newsletters, signatures and warnings. Calls the appropriate function based on $_POST['item']

safe_file_write Writes data to a file, optionally making a backup, while avoiding race conditions.
safe_serialize Wrapper for _safe_serialize() that handles exceptions and multibyte encoding issues.
safe_unserialize Wrapper for _safe_unserialize() that handles exceptions and multibyte encoding issue
sanitize_iri

A wrapper for filter_var($url, FILTER_SANITIZE_URL) that can handle URLs with international characters (a.k.a. IRIs)

sanitizeMSCutPaste

Microsoft uses their own character set Code Page 1252 (CP1252), which is a superset of ISO 8859-1, defining several characters between DEC 128 and 159 that are not normally displayable. This converts the popular ones that appear from a cut and paste from windows.

saveDBSettings Helper function for saving database settings.
SaveDraft

Saves a post draft in the user_drafts table The core draft feature must be enabled, as well as the post draft option Determines if this is a new or an existing draft Returns errors in $post_errors for display in the template

saveModComment Inserts a new moderator comment to the DB.
SavePMDraft

Saves a PM draft in the user_drafts table The core draft feature must be enabled, as well as the pm draft option Determines if this is a new or and update to an existing pm draft

saveProfileChanges Save the profile changes
saveProfileFields Save the profile changes.
saveSettings Helper function. Saves settings by putting them in Settings.php or saving them in the settings table.
saveTriggers

Saves one or more ban triggers into a ban item: according to the suggestions checks the $_POST variable to verify if the trigger is present

scheduled_birthdayemails Happy birthday!!
scheduled_daily_digest Send out a daily email of all subscribed topics.
scheduled_daily_maintenance Do some daily cleaning up.
scheduled_fetchSMfiles This retieves data (e.g. last version of SMF) from sm.org
scheduled_paid_subscriptions Perform the standard checks on expiring/near expiring subscriptions.
scheduled_remove_old_drafts Check for old drafts and remove them
scheduled_remove_temp_attachments

Check for un-posted attachments is something we can do once in a while :P This function uses opendir cycling through all the attachments

scheduled_remove_topic_redirect Check for move topic notices that have past their best by date
scheduled_weekly_digest Like the daily stuff - just seven times less regular ;)
scheduled_weekly_maintenance Weekly maintenance
ScheduledTasks List all the scheduled task in place on the forum.
SearchEngines Entry point for this section.
SearchMembers

Search the member list, using one or more criteria. Called by ?action=admin;area=viewmembers;sa=search. Requires the moderate_forum permission. form is submitted to action=admin;area=viewmembers;sa=query.

searchSort

This function compares the length of two strings plus a little. What it does: - callback function for usort used to sort the fulltext results. - passes sorting duty to the current API.

SecretAnswer2 Validates the secret answer input by the user
SecretAnswerInput Allows the user to enter their secret answer
secureDirectory A generic function to create a pair of index.php and .htaccess files in a directory
SelectMailingMembers

This function allows a user to select the membergroups to send their mailing to. Called by ?action=admin;area=news;sa=mailingmembers. Requires the send_mail permission. Form is submitted to ?action=admin;area=news;mailingcompose.

send_http_status Sends an appropriate HTTP status header based on a given status code
SendActivation It doesn't actually send anything, this action just shows a message for a guest.
sendmail

This function sends an email to the specified recipient(s). It uses the mail_type settings and webmaster_email variable.

SendMailing

Handles the sending of the forum mailing in batches. Called by ?action=admin;area=news;sa=mailingsend Requires the send_mail permission. Redirects to itself when more batches need to be sent. Redirects to ?action=admin;area=news;sa=mailingmembers after everything has been sent.

sendNotifications

Sends a notification to members who have elected to receive emails when things happen to a topic, such as replies are posted. The function automatically finds the subject and its board, and checks permissions for each member who is "signed up" for notifications. It will not send 'reply' notifications more than once in a row.

sendpm

Sends an personal message from the specified person to the specified people ($from defaults to the user)

sentence_list Concatenates an array of strings into a grammatically correct sentence list
serialize_to_json
sessionClose

Implementation of sessionClose() replacing the standard close handler. It simply returns true.

sessionDestroy Implementation of sessionDestroy() replacing the standard destroy handler.
sessionGC

Implementation of sessionGC() replacing the standard gc handler. Callback for garbage collection.

sessionOpen

Implementation of sessionOpen() replacing the standard open handler. It simply returns true.

sessionRead Implementation of sessionRead() replacing the standard read handler.
sessionWrite Implementation of sessionWrite() replacing the standard write handler.
set_alert_icon Sets the icon for a fetched alert.
set_avatar_data Helper function to set an array of data for an user's avatar.
set_fatal_error_headers

Small utility function for fatal error pages. Used by display_db_error(), display_loadavg_error(), display_maintenance_message()

set_tld_regex Creates an optimized regex to match all known top level domains.
SetCensor

Shows an interface to set and test censored words. It uses the censor_vulgar, censor_proper, censorWholeWord, and censorIgnoreCase settings. Requires the admin_forum permission. Accessed from ?action=admin;area=postsettings;sa=censor.

setEventStartEnd

Set the start and end dates and times for a posted event for insertion into the database. Validates all date and times given to it. Makes sure events do not exceed the maximum allowed duration (if any). If passed an array that defines any time or date parameters, they will be used. Otherwise, gets the values from $_POST.

SetJavaScript

Set an option via javascript. - sets a theme option without outputting anything. - can be used with javascript, via a dummy image... (which doesn't require the page to reload.) - requires someone who is logged in. - accessed via ?action=jsoption;var=variable;val=value;session_var=sess_id. - does not log access to the Who's Online log. (in index.php..)

setKeys Set the keys in use by the tables - these ensure entries MUST exist if the data isn't sent.
setLoginCookie

Sets the SMF-style login cookie and session based on the id_member and password passed. - password should be already encrypted with the cookie salt. - logs the user out if id_member is zero. - sets the cookie and session to last the number of seconds specified by cookie_length, or ends them if cookie_length is less than 0. - when logging out, if the globalCookies setting is enabled, attempts to clear the subdomain's cookie too.

setMemoryLimit

Helper function to set the system memory to a needed value - If the needed memory is greater than current, will attempt to get more - if in_use is set to true, will also try to take the current memory usage in to account

setNotifyPrefs Sets the list of preferences for a single user.
setPassword Allows the user to set their new password
setPassword2 Actually sets the new password
SetQuickGroups

Handles permission modification actions from the upper part of the permission manager index.

SetReserved

Set the names under which users are not allowed to register. Accessed by ?action=admin;area=regcenter;sa=reservednames. Requires the admin_forum permission.

setSqlMode
setTFACookie Sets Two Factor Auth cookie
SetThemeOptions Administrative global settings.
SetThemeSettings

Administrative global settings. - saves and requests global theme settings. ($settings) - loads the Admin language file. - calls ThemeAdmin() if no theme is specified. (the theme center.) - requires admin_forum permission. - accessed with ?action=admin;area=theme;sa=list&th=xx.

setup_fatal_error_context It is called by fatal_error() and fatal_lang_error().
setupMenuContext

Sets up all of the top menu buttons Saves them in the cache if it is available and on Places the results in $context

setupProfileContext Setup the context for a page load!
setupThemeContext Sets up the basic theme context stuff.
sha1_core This is the core SHA-1 calculation routine, used by sha1().
sha1_ft Helper function for the core SHA-1 calculation
sha1_kt Helper function for the core SHA-1 calculation
sha1_raw

Available since: (PHP 5) If the optional raw_output is set to TRUE, then the sha1 digest is instead returned in raw binary format with a length of 20, otherwise the returned value is a 40-character hexadecimal number.

sha1_rol Helper function for the core SHA-1 calculation
sha1_smf Define the old SMF sha1 function. Uses mhash if available
shorten_subject Shorten a subject + internationalization concerns.
ShowAdminHelp

Show some of the more detailed help to give the admin an idea... It shows a popup for administrative or user help. It uses the help parameter to decide what string to display and where to get the string from. ($helptxt or $txt?) It is accessed via ?action=helpadmin;help=?.

showAlerts Shows all alerts for a member
showAttachment

Downloads an avatar or attachment based on $_GET['attach'], and increments the download count. It requires the view_attachments permission. It disables the session parser, and clears any previous output. It depends on the attachmentUploadDir setting being correct. It is accessed via the query string ?action=dlattach. Views to attachments do not increase hits and are not logged in the "Who's Online" log.

showAttachments Show all the attachments belonging to a member.
ShowClosedReports Shows all currently closed reported posts.
showCodeImage

Show an image containing the visual verification code for registration. Requires the GD extension. Uses a random font for each letter from default_theme_dir/fonts. Outputs a gif or a png (depending on whether gif ix supported).

ShowCustomProfiles Show all the custom profile fields available to the user.
ShowDrafts

Loads in a group of drafts for the user of a given type (0/posts, 1/pm's) loads a specific draft for forum use if selected. Used in the posting screens to allow draft selection Will load a draft if selected is supplied via post

ShowHelp

Redirect to the user help ;). It loads information needed for the help section. It is accessed by ?action=help.

showLetterImage

Show a letter for the visual verification code. Alternative function for showCodeImage() in case GD is missing. Includes an image from a random sub directory of default_theme_dir/fonts.

ShowNotice Show a notice sent to a user.
showPermissions Shows which permissions a user has
ShowPHPinfoSettings Allows us to see the servers php settings
showPMDrafts

Show all PM drafts of the current user Uses the showpmdraft template Allows for the deleting and loading/editing of drafts

showPosts Show all posts by a member
showProfileDrafts

Show all drafts of a given type by the current user Uses the showdraft template Allows for the deleting and loading/editing of drafts

ShowReports

Shows all currently open reported posts. Handles closing multiple reports

showUnwatched Show all the unwatched topics.
ShowXmlFeed

Outputs xml data representing recent information or a profile. Can be passed 4 subactions which decide what is output: 'recent' for recent posts, 'news' for news topics, 'members' for recently registered members, 'profile' for a member's profile. To display a member's profile, a user id has to be given. (;u=1) Outputs an rss feed instead of a proprietary one if the 'type' $_GET parameter is 'rss' or 'rss2'. Accessed via ?action=.xml. Does not use any templates, sub templates, or template layers.

sig_preview Handles previewing signatures
smf_chmod Tries different modes to make file/dirs writable. Wrapper function for chmod()
smf_crc32
smf_db_add_column
smf_db_add_index
smf_db_affected_rows
smf_db_allow_persistent
smf_db_backup_table
smf_db_calculate_type
smf_db_change_column
smf_db_create_query_column Creates a query for a column
smf_db_create_table
smf_db_create_word_search
smf_db_cte_support
smf_db_custom_order
smf_db_drop_table
smf_db_error
smf_db_error_backtrace
smf_db_error_insert
smf_db_escape_string
smf_db_escape_wildcard_string
smf_db_fetch_all
smf_db_get_server_info Wrap mysqli_get_server_info so the connection does not need to be specified
smf_db_get_vendor
smf_db_get_version
smf_db_initiate
smf_db_insert
smf_db_insert_id
smf_db_list_columns
smf_db_list_indexes
smf_db_list_tables
smf_db_native_replace
smf_db_optimize_table
smf_db_query
smf_db_quote
smf_db_remove_column
smf_db_remove_index
smf_db_replacement__callback
smf_db_search_language Return the language for the textsearch index
smf_db_search_query Returns the correct query for this search type.
smf_db_search_support
smf_db_select Wrap mysqli_select_db so the connection does not need to be specified
smf_db_select_db Dummy function really. Doesn't do anything on PostgreSQL.
smf_db_table_sql
smf_db_table_structure
smf_db_transaction
smf_db_version Get the current version.
smf_error_handler

Handler for standard error messages, standard PHP error handler replacement. It dies with fatal_error() if the error_level matches with error_reporting.

smf_error_handler_cron The error handling function
smf_is_resource

Validates whether the resource is a valid mysqli instance. Mysqli uses objects rather than resource. https://bugs.php.net/bug.php?id=42797

smf_json_decode Wrapper function for json_decode() with error handling.
smf_list_timezones Get a list of timezones.
smf_main

The main dispatcher. This delegates to each area.

smf_mysql_fetch_assoc
smf_mysql_fetch_row
smf_mysql_free_result
smf_mysql_insert_id
smf_mysql_num_rows
smf_mysql_real_escape_string
smf_seed_generator Generate a random seed and ensure it's stored in settings.
smf_serverResponse

Outputs a response. It assumes the data is already a string.

smf_setcookie A wrapper for setcookie that gives integration hook access to it
smf_strtolower UTF-8 aware strtolower function.
smf_var_export A wrapper around var_export whose output matches SMF coding conventions.
SMStats

This is the function which returns stats to simplemachines.org IF enabled! called by simplemachines.org. only returns anything if stats was enabled during installation. can also be accessed by the admin, to show what stats sm.org collects. does not return any data directly to sm.org, instead starts a new request for security.

sortBoards Takes a board array and sorts it
sortCategories Takes a category array and sorts it
spamProtection

This function attempts to protect from spammed messages and the like. The time taken depends on error_type - generally uses the modSetting.

spell_check spell_check()
spell_init spell_init()
spell_suggest spell_suggest()
SpellCheck

Spell checks the post for typos ;). It uses the pspell or enchant library, one of which MUST be installed. It has problems with internationalization. It is accessed via ?action=spellcheck.

SpiderCheck Do we think the current user is a spider?
SpiderLogs See what spiders have been up to.
SpiderStats Show the spider statistics.
SplitExecute

do the actual split. is accessed with ?action=splittopics;sa=execute. uses the main SplitTopics template. supports three ways of splitting: (1) only one message is split off. (2) all messages after and including a given message are split off. (3) select topics to split (redirects to SplitSelectTopics()). uses splitTopic function to do the actual splitting.

SplitIndex

screen shown before the actual split. is accessed with ?action=splittopics;sa=index. default sub action for ?action=splittopics. uses 'ask' sub template of the SplitTopics template. redirects to SplitSelectTopics if the message given turns out to be the first message of a topic. shows the user three ways to split the current topic.

SplitSelectionExecute

do the actual split of a selection of topics. is accessed with ?action=splittopics;sa=splitSelection. uses the main SplitTopics template. uses splitTopic function to do the actual splitting.

SplitSelectTopics

allows the user to select the messages to be split. is accessed with ?action=splittopics;sa=selectTopics. uses 'select' sub template of the SplitTopics template or (for XMLhttp) the 'split' sub template of the Xml template. supports XMLhttp for adding/removing a message to the selection. uses a session variable to store the selected topics. shows two independent page indexes for both the selected and not-selected messages (;topic=1.x;start2=y).

splitTopic

general function to split off a topic. creates a new topic and moves the messages with the IDs in array messagesToBeSplit to the new topic. the subject of the newly created topic is set to 'newSubject'. marks the newly created message as read for the user splitting it. updates the statistics to reflect a newly created topic. logs the action in the moderation log. a notification is sent to all users monitoring this topic.

SplitTopics

splits a topic into two topics. delegates to the other functions (based on the URL parameter 'sa'). loads the SplitTopics template. requires the split_any permission. is accessed with ?action=splittopics.

ssi_boardNews Show the latest news, with a template... by board.
ssi_boardStats Show some basic stats: Total This: XXXX, etc.
ssi_checkPassword Checks whether the specified password is correct for the specified user.
ssi_copyright Show the forum copyright. Only used in our ssi_examples files.
ssi_fetchGroupMembers Get al members in the specified group
ssi_fetchMember Fetch specific members
ssi_fetchPosts Fetches one or more posts by ID.
ssi_full_version Show the full SMF version string.
ssi_latestMember Show a link to the latest member: Please welcome, Someone, our latest member.
ssi_login Shows a login box
ssi_logOnline Just like whosOnline except it also logs the online presence.
ssi_logout Show a logout link.
ssi_menubar Display a menu bar, like is displayed at the top of the forum.
ssi_news Show a random forum news item
ssi_pollVote Handles voting in a poll (done automatically)
ssi_queryMembers Pulls info about members based on the specified parameters. Used by other functions to eliminate duplication.
ssi_queryPosts This handles actually pulling post info. Called from other functions to eliminate duplication.
ssi_quickSearch Shows a search box
ssi_randomMember Fetches a random member.
ssi_recentAttachments Shows the most recent attachments that the user can see
ssi_recentEvents Show the most recent events
ssi_recentPoll Shows the most recent poll
ssi_recentPosts Recent post list: [board] Subject by Poster Date
ssi_recentTopics Recent topic list: [board] Subject by Poster Date
ssi_showPoll Shows the poll from the specified topic
ssi_shutdown This shuts down the SSI and shows the footer.
ssi_software_year Show the SMF software year.
ssi_todaysBirthdays Show today's birthdays.
ssi_todaysCalendar Shows today's calendar items (events, birthdays and holidays)
ssi_todaysEvents
ssi_todaysHolidays Shows today's holidays.
ssi_topBoards Shows a list of top boards based on activity
ssi_topPoll Show the top poll based on votes
ssi_topPoster Shows a list of top posters
ssi_topTopics Shows a list of top topics based on views or replies
ssi_topTopicsReplies Top topics based on replies
ssi_topTopicsViews Top topics based on views
ssi_version Show the SMF version.
ssi_welcome Display a welcome message, like: Hey, User, you have 0 messages, 0 are new.
ssi_whosOnline Shows a list of online users: YY Guests, ZZ Users and then a list...
ssl_cert_found Check if the passed url has an SSL certificate.
StaffReport

Report for showing all the forum staff members - quite a feat! functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

statPanel Gets the user stats for display
Sticky

Sticky a topic. Can't be done by topic starters - that would be annoying! What this does: - stickies a topic - toggles between sticky and normal. - requires the make_sticky permission. - adds an entry to the moderator log. - when done, sends the user back to the topic. - accessed via ?action=sticky.

strip_php_comments

Deletes all PHP comments from a string. Useful when analyzing input from file_get_contents, etc.

stripslashes__recursive

Remove slashes recursively. Uses two underscores to guard against overloading. What it does: - removes slashes, recursively, from the array or string var. - effects both keys and values of arrays. - calls itself recursively to handle arrays of arrays.

subscriptions Function for doing all the paid subscription stuff - kinda.
summary View a summary.
TaskLog Show the log of all tasks that have taken place.
TaskSettings
template_action_permissions A progress page showing what permissions changes are being applied
template_add_edit_group_boards_list The template for determining which boards a group has access to.
template_add_language Add a new language
template_add_rule Template for adding/editing a rule.
template_additional_rows This template displays additional rows above or below the list.
template_addsmiley Adding a new smiley.
template_admin This is the administration center home.
template_admin_account
template_admin_browse The admin member list.
template_admin_login This is for the security stuff - makes administrators login every so often.
template_admin_quick_search This shows the admin search form
template_admin_register The template for the form allowing an admin to register a user from the admin center.
template_admin_search_results Results page for an admin search.
template_after After registration... all done ;).
template_alert_configuration The template for configuring alerts
template_alert_notifications_boards Template for showing which boards you're subscribed to
template_alert_notifications_topics Template for showing which topics you're subscribed to
template_alerts_all_read A simple template to say "You don't have any unread alerts".
template_alerts_popup The "popup" showing the user's alerts
template_announce The form for sending out an announcement
template_announcement_send The confirmation/progress page, displayed after the admin has clicked the button to send the announcement.
template_ask
template_ask_delete This template asks the user whether they wish to empty out their folder/messages.
template_attachment_errors This template handles showing attachment-related errors
template_attachment_paths The page that handles managing attachment paths.
template_attachment_repair The file repair page
template_avatar_settings_above This template wraps around the simple settings page to add javascript functionality.
template_avatar_settings_below JavaScript to be output below the simple settings page
template_backup_database
template_backup_xml
template_ban_edit Add or edit a ban
template_ban_edit_trigger Add or edit a ban trigger
template_bcd
template_bi_board_children
template_bi_board_icon
template_bi_board_info
template_bi_board_lastpost
template_bi_board_stats
template_bi_redirect_icon
template_bi_redirect_stats
template_boardindex_outer_above The top part of the outer layer of the boardindex
template_boardindex_outer_below The lower part of the outer layer of the board index
template_body_above The upper part of the main template layer. This is the stuff that shows above the main forum content.
template_body_below The stuff shown immediately below the main content, including the footer
template_browse
template_button_strip
template_by_board THe page that shows which permissions profile applies to each board
template_calendar_top Calendar controls under the title
template_callback_question_answer_list This little beauty shows questions and answer from the captcha type feature.
template_check_username The XML for instantly showing whether a username is valid on the registration page
template_chmod
template_chmod_files
template_choose_payment The "choose payment" dialog.
template_clean_cache_button_above
template_clean_cache_button_below Content shown below the clean cache button?
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_category_delete A template to confirm if a user wishes to delete a category - and whether they want to save the boards.
template_control_chmod CHMOD control form
template_control_richedit This function displays all the stuff you get with a richedit box - BBC, smileys, etc.
template_control_richedit_buttons This template shows the form buttons at the bottom of the editor
template_control_verification This template displays a verification form
template_convert_entities Template for converting entities to UTF-8 characters
template_convert_msgbody Template for converting posts to UTF-8.
template_convert_utf8
template_convert_xml
template_coppa Template for giving instructions about COPPA activation.
template_coppa_form An easily printable form for giving permission to access the forum for a minor.
template_copy_template The page allowing you to copy a template from one theme to another.
template_create_index Create a search index.
template_create_index_done Done creating a search index.
template_create_index_progress Display a progress page while creating a search index.
template_create_list_menu This function creates a menu
template_credits
template_css Output the CSS files
template_database_changes
template_database_settings
template_database_xml
template_delete_install
template_delete_subscription The page for deleting a subscription.
template_deleteAccount Template to show for deleting a user's account - now with added delete post capability!
template_download_language Download a new language file.
template_downloaded Confirmation page showing a package was uploaded/downloaded successfully.
template_edit_agreement Form for editing the agreement shown for people registering to the forum.
template_edit_browse This lets you browse a list of files in a theme so you can choose which one to edit.
template_edit_censored Form for stopping people using naughty words, etc.
template_edit_comment Template for editing a mod comment.
template_edit_file This allows you to edit a file
template_edit_group Edit an existing membergroup.
template_edit_holiday Editing or adding holidays.
template_edit_list The page for editing themes.
template_edit_options Template for editing profile options.
template_edit_profile_field
template_edit_profiles Edit permission profiles (predefined).
template_edit_reserved_words Template for editing reserved words.
template_edit_scheduled_tasks A template for, you guessed it, editing a task!
template_edit_style Wanna edit the stylesheet?
template_edit_template This edits the template...
template_editBuddies Template for showing and managing the buddy list.
template_editicon Editing an individual message icon
template_editicons Editing Message Icons
template_editIgnoreList Template for showing the ignore list of the current user.
template_editsets Shows a list of smiley sets so you can edit them.
template_email_members The template for sending newsletters
template_email_members_compose The form for composing a newsletter
template_email_members_send The page shown while the newsletter is being sent
template_error_log This template handles the error log in the admin center.
template_error_message
template_event_post Template for posting a calendar event.
template_examine Examine a single file within a package
template_extract_package Extract package contents
template_fatal_error THis displays a fatal error message
template_file_permissions The file permissions page.
template_find_members The template for the popup for finding members
template_folder Shows a particular folder (eg inbox or outbox), all the PMs in it, etc.
template_footer The template footer
template_forum_settings
template_ftp_required Wrapper for the above template function showing that FTP is required
template_generic A generic template that outputs any data passed to it...
template_generic_menu
template_generic_menu_dropdown_above This contains the HTML for the menu bar at the top of the admin center.
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_tabs The code for displaying the menu
template_generic_xml This prints XML in its most generic form.
template_generic_xml_recursive Recursive function for displaying generic XML data.
template_group_members Template for viewing the members of a group.
template_group_request_reason Allow the moderator to enter a reason to each user being rejected.
template_group_requests_block Show all the group requests the user can see.
template_groupMembership Template for choosing group membership.
template_header The header template
template_hms
template_homepage_sample1
template_homepage_sample1_html
template_homepage_sample1_php
template_html_above The main sub template above the content.
template_html_below This shows any deferred JavaScript and closes out the HTML
template_ic_block_calendar The calendar section of the info center
template_ic_block_online The who's online section of the admin center
template_ic_block_recent The recent posts section of the info center
template_ic_block_stats The stats section of the info center
template_ignoreboards Template for managing ignored boards
template_include

Load the template/language file using require - loads the template or language file specified by filename. - uses eval unless disableTemplateEval is enabled. - outputs a parse error if the file did not exist or contained errors. - attempts to detect the error and line, and show detailed information.

template_info_center Displays the info center
template_init Initialize the template... mainly little settings.
template_inline_permissions A form for displaying inline permissions, such as on a settings page.
template_install_above
template_install_below
template_install_options Installation options - FTP info and backup settings
template_installed Okay, that theme was installed/updated successfully!
template_issueWarning
template_javascript

Output the Javascript files - tabbing in this function is to make the HTML source look good and proper - if deferred is set function will output all JS set to load at page end

template_jump_to The XML for the Jump To box
template_kick_guest Tell a guest to get lost or login!
template_labels Here we allow the user to setup labels, remove labels and change rules for labels (i.e, do quite a bit)
template_like Display a like button and info about how many people liked something
template_list List files in a package
template_list_themes This lists all themes
template_load_warning_variables Simply loads some theme variables common to several warning templates.
template_login This is just the basic "login" form.
template_login_tfa TFA authentication form
template_mailtest Template for testing mail send.
template_main
template_maint_warning_above The upper part of the maintenance warning box
template_maint_warning_below The lower part of the maintenance warning box.
template_maintain_database Template for the database maintenance tasks.
template_maintain_members Template for the member maintenance tasks.
template_maintain_routine Template for the routine maintenance tasks.
template_maintain_topics Template for the topic maintenance tasks.
template_maintenance
template_manual The main help page
template_max_size This is just a really little helper to avoid duplicating code unnecessarily
template_menu
template_merge Merge topic page.
template_merge_done Confirmation page shown when finished merging topics.
template_merge_extra_options Extra options related to merging topics.
template_message_icons The XML for displaying a column of message icons and selecting one via AJAX
template_moderation_center The main moderation center.
template_moderation_settings The moderation settings page.
template_modify_board Below is the template for adding/editing a board on the forum.
template_modify_category Template for editing/adding a category on the forum.
template_modify_group Modify a group's permissions
template_modify_group_display The way of looking at permissions.
template_modify_language_entries Edit language entries. Note that this doesn't always work because of PHP's max_post_vars setting.
template_modify_subscription The template for adding or editing a subscription.
template_modify_user_subscription Add or edit an existing subscriber.
template_modify_weights Modify the search weights.
template_modifydone The XML for handling things when you're done editing a post inline
template_modifyfast This defines the XML for the inline edit feature
template_modifyset Modifying a smiley set.
template_modifysmiley Editing an individual smiley
template_modifytopicdone This handles things when editing a topic's subject from the messageindex.
template_move Show an interface for selecting which board to move a post to.
template_new_group Add a new membergroup.
template_news_lists The settings page.
template_newsfader This shows the newsfader
template_not_done This is the page shown when we've temporarily paused things such as during maintenance tasks, sending newsletters, etc.
template_notes Little section for making... notes.
template_notify_board Board notification bar.
template_omfg
template_optimize Simple template for showing results of our optimization...
template_options This pseudo-template defines all the theme options
template_package_confirm Confirm package operation
template_package_list List packages.
template_paid_done The "thank you" bit...
template_permission_index The main manage permissions page
template_permission_show_contents Shows permissions for items within a directory (called from template_file_permissions)
template_php_info Retrieves info from the php_info function, scrubs and preps it for display
template_pick This template allows for the selection of different themes ;)
template_pm All the XML for previewing a PM
template_pm_above This is for stuff above the menu in the personal messages section
template_pm_below Just the end of the index bar, nothing special.
template_pm_popup
template_populate_database
template_popup
template_post The massive XML for previewing posts.
template_post_header Prints the input fields in the form's header (subject, message icon, guest name & email, etc.)
template_postmod_permissions Edit post moderation permissions.
template_print The main print page
template_print_above
template_print_below
template_print_options
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_avatar_select Template for selecting an avatar
template_profile_below Template for any HTML needed below the profile (closing off divs/tables, etc.)
template_profile_birthdate Callback function for entering a birthdate!
template_profile_group_manage Display a load of drop down selectors for allowing the user to change group.
template_profile_pm_settings Personal Message settings.
template_profile_popup Template for showing off the spiffy popup of the menu
template_profile_save Template for the password box/save button stuck at the bottom of every profile page.
template_profile_signature_modify Show the signature editing box?
template_profile_smiley_pick Smiley set picker.
template_profile_tfa Simple template for showing the 2FA area when editing a profile.
template_profile_theme_pick Template for picking a theme
template_profile_theme_settings Template for showing theme settings. Note: template_options() actually adds the theme specific options.
template_profile_timeformat_modify Select the time format!
template_prune This template asks the user what messages they want to prune.
template_quickbuttons Generate a list of quickbuttons.
template_quickreply The template for displaying the quick reply box.
template_quotefast
template_recent Template for showing recent posts
template_redirect_options Redirection topic options
template_registration_agreement Before showing users a registration form, show them the registration agreement.
template_registration_form Before registering - get their information.
template_reminder_pick The page to pick an option - secret question/answer (if set) or email
template_repair_boards Repairing boards.
template_replies Template for showing unread replies (eg new replies to topics you've posted in)
template_report_message Template for reporting a personal message.
template_report_message_complete Little template just to say "Yep, it's been submitted"
template_report_type Choose which type of report to run?
template_reported_members Lists all reported members
template_reported_members_block A block to show the current top reported member profiles.
template_reported_posts Displays all reported posts.
template_reported_posts_block
template_reported_users_block A list of reported users
template_resend The form for resending the activation code.
template_reset_list This lets you reset themes
template_results
template_retry_activate Activate your account manually?
template_rules Manage rules.
template_search
template_search_members The admin member search form
template_search_results Displays results from a PM search
template_select The form for selecting which posts to split.
template_select_search_method Select the search method.
template_send The form for sending a new PM
template_sendbody
template_sent Just a simple "We sent you an email. Click the link in it to continue." message
template_serialize_json
template_serialize_json_xml
template_servers List package servers
template_set_options This displays the form for setting theme options
template_set_password Template for setting the new password
template_set_settings The page for setting and managing theme settings.
template_setorder Ordering smileys.
template_settings This pseudo-template defines all the available theme settings (but not their actual values)
template_show_backtrace This template shows a backtrace of the given error
template_show_custom_profile Template for showing custom profile fields.
template_show_file This template shows a snippet of code from a file and highlights which line caused the error.
template_show_list This template handles displaying a list
template_show_month_grid Display a monthly calendar grid.
template_show_notice Show a notice sent to a user.
template_show_settings Template for showing settings (Of any kind really!)
template_show_spider_logs Show... spider... logs...
template_show_spider_stats Show... spider... stats...
template_show_upcoming_list Display a list of upcoming events, birthdays, and holidays.
template_show_week_grid Shows a weekly grid
template_showAlerts Template for showing all alerts
template_showDrafts Template for showing all of a user's drafts
template_showPermissions This template shows an admin which permissions a user have and which group(s) give them each permission.
template_showPMDrafts Template for showing all of a user's PM drafts.
template_showPosts Template for showing all the posts of the user, in chronological order.
template_single_pm Template for displaying a single personal message.
template_single_post Template for displaying a single post.
template_spellcheck The template for the spellchecker.
template_spider_edit Add or edit a search engine spider.
template_split The XML for selecting items to split
template_ssi_above
template_ssi_below
template_statPanel Template for user statistics, showing graphs and the like.
template_stats The XML for hiding/showing stats sections via AJAX
template_subject_list Just list all the personal message subjects - to make templates easier.
template_summary This template displays a user's details without any option to edit them.
template_terms The rules page
template_tfadisable Template for disabling two-factor authentication.
template_tfasetup Template for setting up and managing Two-Factor Authentication.
template_tfasetup_backup Template for setting up 2FA backup code
template_thetime
template_topic_legend Shows a legend for topic icons.
template_trackActivity This template shows an admin information on a users IP addresses used and errors attributed to them.
template_trackIP The template for trackIP, allowing the admin to see where/who a certain IP has been used.
template_unapproved_posts Show a list of all the unapproved posts
template_unread Template for showing unread posts
template_upgrade_above
template_upgrade_below
template_upgrade_complete
template_upgrade_options
template_user_subscription Template for a user to edit/pick their subscriptions.
template_user_watch_post_callback Callback function for showing a watched users post in the table.
template_verification_sound Show a window containing the spoken verification code.
template_view_operations View operation details.
template_view_package View package details when installing/uninstalling
template_view_scheduled_tasks Template for listing all scheduled tasks.
template_view_versions Displays information about file versions installed, and compares them to current version.
template_viewmemberreport Template for viewing and managing a specific report about a user's profile
template_viewmodreport Handles viewing details of and managing a specific report
template_viewWarning
template_warn_template Add or edit a warning template.
template_warning The XML for previewing a warning
template_warning_divs
template_watched_users A list of watched users
template_welcome_message
template_xml_above
template_xml_below
TestMailSend Test mail sending ability.
text2words Chops a string into words and prepares them to be inserted into (or searched from) the database.
textfield_alter Alter a text column definition preserving its character set.
tfadisable Provides interface to disable two-factor authentication in SMF
tfasetup Provides interface to setup Two Factor Auth in SMF
theme Handles the "Look and Layout" section of the profile
theme_copyright Show the copyright.
theme_inline_permissions

Show a collapsible box to set a specific permission. The function is called by templates to show a list of permissions settings. Calls the template function template_inline_permissions().

theme_install Inserts a theme's data to the DataBase.
theme_linktree
ThemeAdmin

This function allows administration of themes and their settings, as well as global theme settings. - sets the settings theme_allow, theme_guests, and knownThemes. - requires the admin_forum permission. - accessed with ?action=admin;area=theme;sa=admin.

ThemeInstall

Installs new themes, calls the respective function according to the install type. - puts themes in $boardurl/Themes. - assumes the gzip has a root directory in it. (ie default.) Requires admin_forum. Accessed with ?action=admin;area=theme;sa=install.

ThemeList

This function lists the available themes and provides an interface to reset the paths of all the installed themes.

ThemesMain

Subaction handler - manages the action and delegates control to the proper sub-action. It loads both the Themes and Settings language files. Checks the session by GET or POST to verify the sent data. Requires the user not be a guest. (@todo what?) Accessed via ?action=admin;area=theme.

throw_error Throws a graphical error message.
time_since Little utility function to calculate how long ago a time was.
timeformat Format a time to make it look purdy.
TopicNotify

Turn off/on unread replies subscription for a topic as well as sets individual topic's alert preferences Must be called with a topic specified in the URL. The mode can be from 0 to 3 0 => unwatched, 1 => no alerts/emails, 2 => alerts, 3 => emails/alerts Upon successful completion of action will direct user back to topic. Accessed via ?action=unwatchtopic.

trackActivity Handles tracking a user's activity
trackEdits Tracks a user's profile edits
trackGroupReq Display the history of group requests made by the user whose profile we are viewing.
tracking Loads up the information for the "track user" section of the profile
TrackIP Handles tracking a particular IP address
TrackLogins Tracks a user's logins.
trackStats

Track Statistics. Caches statistics changes, and flushes them if you pass nothing. If '+' is used as a value, it will be incremented. It does not actually commit the changes until the end of the page view. It depends on the trackStats setting.

trackStatsUsersOnline Check if the number of users online is a record and store it.
TransferAttachments Maintance function to move attachments from one directory to another
truncate_array Truncate an array to a specified length
un_htmlspecialchars Replaces special entities in strings with the real characters.
un_preparsecode This is very simple, and just removes things done by preparsecode.
UnapprovedAttachments View all unapproved attachments.
UnapprovedPosts View all unapproved posts.
unescapestring__recursive

Unescapes any array or variable. Uses two underscores to guard against overloading. What it does: - unescapes, recursively, from the array or string var. - effects both keys and values of arrays. - calls itself recursively to handle arrays of arrays.

UnreadTopics Find unread topics and replies.
updateAdminPreferences Saves the admin's current preferences to the database.
updateBanGroup Updates an existing ban group
updateBanMembers

As it says... this tries to review the list of banned members, to match new bans. Note: is_activated >= 10: a member is banned.

updateBoardManagers Makes sure $modSettings['board_manager_groups'] is up to date.
updateChildPermissions This function updates the permissions of any groups based off this group.
updateDbLastError

Saves the time of the last db error for the error log - Done separately from updateSettingsFile to avoid race conditions which can occur during a db error - If it fails Settings.php will assume 0

updateLastMessages

Takes an array of board IDs and updates their last messages. If the board has a parent, that parent board is also automatically updated. The columns updated are id_last_msg and last_updated. Note that id_last_msg should always be updated using this function, and is not automatically updated upon other changes.

updateMemberData

Updates the columns in the members table. Assumes the data has been htmlspecialchar'd. this function should be used whenever member data needs to be updated in place of an UPDATE query.

updateReport Updates a report with the given parameters. Logs each action via logAction()
updateSettings Updates the settings table as well as $modSettings... only does one at a time if $update is true.
updateSettingsFile Update the Settings.php file.
updateStats Update some basic statistics.
updateTriggers This function updates an existing ban trigger into the database
upgrade_clean_cache

Clean the cache using the SMF 2.1 CacheAPI. If coming from SMF 2.0 and below it should wipe the cache using the SMF backend.

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

Checks the existence of a remote file since file_exists() does not do remote. will return false if the file is "moved permanently" or similar.

url_image_size Get the size of a specified image with better error handling.
url_parts

Get the domain and path for the cookie - normally, local and global should be the localCookies and globalCookies settings, respectively. - uses boardurl to determine these two things.

url_to_iri Decodes a URL containing encoded international characters to UTF-8
urldecode__recursive

Removes url stuff from the array/variable. Uses two underscores to guard against overloading. What it does: - takes off url encoding (%20, etc.) from the array or string var. - importantly, does it to keys too! - calls itself recursively if there are any sub arrays.

user_info_callback

Callback function for loademaitemplate on subject and body Uses capture group 1 in array

utf8_strtolower

Converts the given UTF-8 string into lowercase. equivalent to mb_strtolower($string, 'UTF-8')

utf8_strtoupper

Convert the given UTF-8 string to uppercase. equivalent to mb_strtoupper($string, 'UTF-8')

validate_iri

A wrapper for filter_var($url, FILTER_VALIDATE_URL) that can handle URLs with international characters (a.k.a. IRIs)

validateEventPost Makes sure the calendar post is valid.
validatePassword

Checks whether a password meets the current forum rules - called when registering/choosing a password. - checks the password obeys the current forum settings for password strength. - if password checking is enabled, will check that none of the words in restrict_in appear in the password. - returns an error identifier if the password is invalid, or null.

validatePasswordFlood

This protects against brute force attacks on a member's password. Importantly, even if the password was right we DON'T TELL THEM!

validateSession

Check if the user is who he/she says he is Makes sure the user is who they claim to be by requiring a password to be typed in every hour. Is turned on and off by the securityDisable setting. Uses the adminLogin() function of Subs-Auth.php if they need to login, which saves all request (post and get) data.

validateToken Only patrons with valid tokens can ride this ride.
validateTriggers This function validates the ban triggers
validateUsername Checks a username obeys a load of rules
VerificationCode Show the verification code or let it be heard.
VersionDetail

Perform a detailed version check. A very good thing ;). The function parses the comment headers in all files for their version information, and outputs that for some javascript to check with simplemachines.org. It does not connect directly with simplemachines.org, but rather expects the client to.

ViewBacktrace

View a backtrace specified in $_REQUEST['backtrace'], with php highlighting on it Preconditions: - user must have admin_forum permission.

ViewErrorLog

View the forum's error log. This function sets all the context up to show the error log for maintenance. It requires the maintain_forum permission. It is accessed from ?action=admin;area=logs;sa=errorlog.

ViewFile

View a file specified in $_REQUEST['file'], with php highlighting on it Preconditions: - file must be readable, - full file path must be base64 encoded, - user must have admin_forum permission. The line number number is specified by $_REQUEST['line']... The function will try to get the 20 lines before and after the specified line.

ViewMemberlist

View all members list. It allows sorting on several columns, and deletion of selected members. It also handles the search query sent by ?action=admin;area=viewmembers;sa=search. Called by ?action=admin;area=viewmembers;sa=all or ?action=admin;area=viewmembers;sa=query. Requires the moderate_forum permission.

ViewMembers

The main entrance point for the Manage Members screen. As everyone else, it calls a function based on the given sub-action. Called by ?action=admin;area=viewmembers. Requires the moderate_forum permission.

ViewModlog

Prepares the information from the moderation log for viewing. Show the moderation log. If clearing the log, leaves a message in the log to indicate it was cleared, by whom and when. Requires the admin_forum permission. Accessed via ?action=moderate;area=modlog.

ViewOperations List operations
ViewQuery

Show the database queries for debugging What this does: - Toggles the session variable 'view_queries'. - Views a list of queries and analyzes them. - Requires the admin_forum permission. - Is accessed via ?action=viewquery. - Strings in this function have not been internationalized.

ViewSpiders View a list of all the spiders we know about.
ViewSubscribedUsers

View all the users subscribed to a particular subscription. Requires the admin_forum permission. Accessed from ?action=admin;area=paidsubscribe;sa=viewsub.

ViewSubscriptions

View a list of all the current subscriptions Requires the admin_forum permission. Accessed from ?action=admin;area=paidsubscribe;sa=view.

viewWarning View a member's warnings
ViewWarningLog Simply put, look at the warning log!
ViewWarnings Entry point for viewing warning related stuff.
ViewWarningTemplates Load all the warning templates.
ViewWatchedUsers View watched users.
Vote

Allow the user to vote. It is called to register a vote in a poll. Must be called with a topic and option specified. Requires the poll_vote permission. Upon successful completion of action will direct user back to topic. Accessed via ?action=vote.

warning_preview Handles previewing user warnings
Welcome
WelcomeLogin
Who

Who's online, and what are they doing? This function prepares the who's online data for the Who template. It requires the who_view permission. It is enabled with the who_enabled setting. It is accessed via ?action=who.

WrapAction

Possibly the simplest and best example of how to use the template system. - allows the theme to take care of actions. - happens if $settings['catch_action'] is set and action isn't found in the action array. - can use a template, layers, sub_template, filename, and/or function.

writeLog Put this user in the online log.
XmlDraft

Returns an xml response to an autosave ajax request provides the id of the draft saved and the time it was saved

XMLhttpMain The main handler and designator for AJAX stuff - jumpto, message icons and previews
API documentation generated by ApiGen