Function __global->get_default_option

Definitions

sources/config2.php

  • Get the default value of a config option.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$name ID_TEXT No No required parameter N/A N/A The name of the option

Returns

  • The value (null: disabled / no such option)
  • Type: ?SHORT_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the default value of a config option.
 *
 * @param  ID_TEXT $name The name of the option
 * @return ?SHORT_TEXT The value (null: disabled / no such option)
 */
function get_default_option(string $name) : ?string