Unofficial SMF API Documentation

./Sources/Load.php

• reloadSettings
• loadUserSettings
• loadMinUserInfo
• loadBoard
• loadPermissions
• loadMemberData
• loadMemberContext
• loadMemberCustomFields
• detectBrowser
• isBrowser
• loadTheme
• loadTemplate
• loadSubTemplate
• loadCSSFile
• addInlineCss
• loadJavaScriptFile
• addJavaScriptVar
• addInlineJavaScript
• loadLanguage
• getBoardParents
• getLanguages
• censorText
• template_include
• loadDatabase
• loadCacheAccelerator
• cache_quick_get
• cache_put_data
• cache_get_data
• clean_cache
• set_avatar_data
• get_auth_secret

reloadSettings

function reloadSettings(): void

Load the $modSettings array.

Integration hooks

integrate_load_average

integrate_pre_load

loadUserSettings

function loadUserSettings(): void

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.

Integration hooks

integrate_verify_user

integrate_force_tfasetup

integrate_verify_tfa

integrate_user_info

loadMinUserInfo

function loadMinUserInfo(int|array $user_ids = array()): array

Load minimal user info from members table.

Intended for use by background tasks that need to populate $user_info.

Integration hooks

integrate_load_min_user_settings_columns

integrate_load_min_user_settings

loadBoard

function loadBoard(): void

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.

Integration hooks

integrate_load_board

integrate_board_info

loadPermissions

function loadPermissions(): void

Load this user’s permissions.

loadMemberData

function loadMemberData(mixed $users, bool $is_name = false, string $set = 'normal'): array

Loads user data, either by id or member_name, and can load one or many users’ data together.

User data is loaded with minimal processing into the global $user_profiles array, keyed by user id.

Integration hooks

integrate_load_member_data

loadMemberContext

function loadMemberContext(int $user, bool $display_custom_fields = false): bool

Processes all the data previously loaded by {@link loadMemberData()} into a form more readily usable for SMF.

The results are stored in the global $memberContext array, keyed by user id.

Integration hooks

integrate_member_context

loadMemberCustomFields

function loadMemberCustomFields(int|array $users, string|array $params): array|bool

Loads the user’s custom profile fields

detectBrowser

function detectBrowser(): void

Loads information about what browser the user is viewing with and places it in $context

• uses the class from {@link Class-BrowserDetect.php}

isBrowser

function isBrowser(string $browser): bool

Are we using this browser?

Wrapper function for detectBrowser

loadTheme

function loadTheme(int $id_theme = 0, bool $initialize = true): void

Load a theme, by ID.

Integration hooks

integrate_pre_load_theme

integrate_simple_actions

integrate_load_theme

loadTemplate

function loadTemplate(string|false $template_name, array|string $style_sheets = array(), bool $fatal = true): bool

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.

loadSubTemplate

function loadSubTemplate(string $sub_template_name, bool|string $fatal = false): void

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.

loadCSSFile

function loadCSSFile(string $fileName, array $params = array(), string $id = ''): void

Add a CSS file for output later

addInlineCss

function addInlineCss(string $css): void|bool

Add a block of inline css code to be executed later

• only use this if you have to, generally external css files are better, but for very small changes or for scripts that require help from PHP/whatever, this can be useful.
• all code added with this function is added to the same

loadJavaScriptFile

function loadJavaScriptFile(string $fileName, array $params = array(), string $id = ''): void

Add a Javascript file for output later

addJavaScriptVar

function addJavaScriptVar(string $key, string $value, bool $escape = false): void

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.

addInlineJavaScript

function addInlineJavaScript(string $javascript, bool $defer = false): void|bool

Add a block of inline Javascript code to be executed later

• only use this if you have to, generally external JS files are better, but for very small scripts or for scripts that require help from PHP/whatever, this can be useful.
• all code added with this function is added to the same

loadLanguage

function loadLanguage(string $template_name, string $lang = '', bool $fatal = true, bool $force_reload = false): string

Load a language file. Tries the current and default themes as well as the user and global languages.

getBoardParents

function getBoardParents(int $id_parent): array

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.

getLanguages

function getLanguages(bool $use_cache = true): array

Attempt to reload our known languages.

It will try to choose only utf8 or non-utf8 languages.

censorText

function censorText(string &$text, bool $force = false): string

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.

Integration hooks

integrate_word_censor

template_include

function template_include(string $filename, bool $once = false): void

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.

loadDatabase

function loadDatabase(): void

Initialize a database connection.

loadCacheAccelerator

function loadCacheAccelerator(string $overrideCache = '', bool $fallbackSMF = true): object|false

Try to load up a supported caching method. This is saved in $cacheAPI if we are not overriding it.

cache_quick_get

function cache_quick_get(string $key, string $file, string $function, array $params, int $level = 1): string

Try to retrieve a cache entry. On failure, call the appropriate function.

Integration hooks

pre_cache_quick_get

post_cache_quick_get

cache_put_data

function cache_put_data(string $key, mixed $value, int $ttl = 120): void

Puts value in the cache under key for ttl seconds.

• It may “miss” so shouldn’t be depended on
• Uses the cache engine chosen in the ACP and saved in settings.php
• It supports: memcache: https://php.net/memcache APCu: https://php.net/book.apcu Zend: http://files.zend.com/help/Zend-Platform/output_cache_functions.htm Zend: http://files.zend.com/help/Zend-Platform/zend_cache_functions.htm

Integration hooks

cache_put_data

cache_get_data

function cache_get_data(string $key, int $ttl = 120): ?array

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().

Integration hooks

cache_get_data

clean_cache

function clean_cache(string $type = ''): void

Empty out the cache in use as best it can

It may only remove the files of a certain type (if the $type parameter is given) Type can be user, data or left blank - user clears out user data

• data clears out system / opcode data
• If no type is specified will perform a complete cache clearing For cache engines that do not distinguish on types, a full cache flush will be done

Integration hooks

integrate_clean_cache

set_avatar_data

function set_avatar_data(array $data = array()): array

Helper function to set an array of data for an user’s avatar.

Makes assumptions based on the data provided, the following keys are required:

• avatar The raw “avatar” column in members table
• email The user’s email. Used to get the gravatar info
• filename The attachment filename

Integration hooks

integrate_set_avatar_data

get_auth_secret

function get_auth_secret(): string

Gets, and if necessary creates, the authentication secret to use for cookies, tokens, etc.

Note: Never use the $auth_secret variable directly. Always call this function instead.

Suggest an edit to this page on GitHub