Function Hook_addon_registry_installer->make_option

Definitions

sources/hooks/systems/addon_registry/installer.php

  • Make the UI for an installer textual option.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: object

Parameters

Name Type Default Set Range Description
$nice_name string required parameter N/A N/A The human readable name for the option
$description string required parameter N/A N/A A description of the option
$name ID_TEXT required parameter N/A N/A The name of the option
$value string required parameter N/A N/A The default/current value of the option
$hidden boolean False N/A N/A Whether the options value should be kept starred out (e.g. it is a password)
$required boolean False N/A N/A Whether the option is required

Return

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