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
  • Returns: object

Parameters

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

Returns

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

Preview

Code (PHP)

/**
 * Make the UI for an installer textual option.
 *
 * @param  string $nice_name The human readable name for the option
 * @param  string $description A description of the option
 * @param  ID_TEXT $name The name of the option
 * @param  string $value The default/current value of the option
 * @param  boolean $hidden Whether the options value should be kept starred out (e.g. it is a password)
 * @param  boolean $required Whether the option is required
 * @return Tempcode The option
 */
public function make_option(string $nice_name, string $description, string $name, string $value, bool $hidden = false, bool $required = false) : object