Function __global->_form_input_region

Definitions

sources/locations.php

  • Get the Tempcode for a country and region selection.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$stub ID_TEXT No No required parameter N/A N/A The field name stub
$default ?ID_TEXT No No Null N/A N/A The region ISO code which will be populated in the field by default (null: none)
$required boolean No No False N/A N/A Whether the field is required
$read_only boolean No No False N/A N/A Whether the field cannot be edited
$input_size integer No No 10 N/A N/A The size of the field

Returns

  • A double; the country field and the region field
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the Tempcode for a country and region selection.
 *
 * @param  ID_TEXT $stub The field name stub
 * @param  ?ID_TEXT $default The region ISO code which will be populated in the field by default (null: none)
 * @param  boolean $required Whether the field is required
 * @param  boolean $read_only Whether the field cannot be edited
 * @param  integer $input_size The size of the field
 * @return array A double; the country field and the region field
 */
function _form_input_region(string $stub, ?string $default = null, bool $required = false, bool $read_only = false, int $input_size = 10) : array