Unofficial SMF API Documentation

./Sources/ManageLanguages.php

• ManageLanguages
• AddLanguage
• list_getLanguagesList
• DownloadLanguage
• ModifyLanguages
• list_getNumLanguages
• list_getLanguages
• ModifyLanguageSettings
• ModifyLanguage
• cleanLangString

ManageLanguages

function ManageLanguages(): void

This is the main function for the languages area.

It dispatches the requests. Loads the ManageLanguages template. (sub-actions will use it)

Integration hooks

integrate_manage_languages

AddLanguage

function AddLanguage(): void

Interface for adding a new language

list_getLanguagesList

function list_getLanguagesList(): array

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

DownloadLanguage

function DownloadLanguage(): void

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.

ModifyLanguages

function ModifyLanguages(): void

This lists all the current languages and allows editing of them.

list_getNumLanguages

function list_getNumLanguages(): int

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

list_getLanguages

function list_getLanguages(): array

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.

ModifyLanguageSettings

function ModifyLanguageSettings(bool $return_config = false): void|array

Edit language related settings.

Integration hooks

integrate_language_settings

integrate_save_language_settings

ModifyLanguage

function ModifyLanguage(): void

Edit a particular set of language entries.

Integration hooks

integrate_modifylanguages

integrate_language_edit_helptext

cleanLangString

function cleanLangString(string $string, bool $to_display = true): string

This function cleans language entries to/from display.

Suggest an edit to this page on GitHub