Function __global->build_config_inputter

Definitions

sources/config2.php

  • Build the UI for inputting a config option.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$name string No No required parameter N/A N/A Option name
$details array No No required parameter N/A N/A Option details
$current_value ?string No No Null N/A N/A Current value (null: get from live config)
$is_override boolean No No False N/A N/A Whether this is an override (which may change inputting style)
$include_group boolean No No False N/A N/A Whether to include the config group title as part of the inputter

Returns

  • Inputter
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Build the UI for inputting a config option.
 *
 * @param  string $name Option name
 * @param  array $details Option details
 * @param  ?string $current_value Current value (null: get from live config)
 * @param  boolean $is_override Whether this is an override (which may change inputting style)
 * @param  boolean $include_group Whether to include the config group title as part of the inputter
 * @return Tempcode Inputter
 */
function build_config_inputter(string $name, array $details, ?string $current_value = null, bool $is_override = false, bool $include_group = false) : object