Function Module_admin_lang->choose_lang

Definitions

adminzone/pages/modules/admin_lang.php

  • The UI to choose a language.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$title Tempcode No No required parameter N/A N/A The title to show when choosing a language
$choose_lang_file boolean No No False N/A N/A Whether to also choose a language file
$add_lang boolean No No False N/A N/A Whether the user may add a language
$text mixed No No Blank (empty string) N/A N/A Text message to show, provided in HTML format (string or Tempcode)
$param_name ID_TEXT No No lang N/A N/A The name of the parameter for specifying language

Returns

  • The UI
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * The UI to choose a language.
 *
 * @param  Tempcode $title The title to show when choosing a language
 * @param  boolean $choose_lang_file Whether to also choose a language file
 * @param  boolean $add_lang Whether the user may add a language
 * @param  mixed $text Text message to show, provided in HTML format (string or Tempcode)
 * @param  ID_TEXT $param_name The name of the parameter for specifying language
 * @return Tempcode The UI
 */
public function choose_lang(object $title, bool $choose_lang_file = false, bool $add_lang = false, $text = '', string $param_name = 'lang') : object