Function __global->_form_input_date

Definitions

sources/form_templates.php

  • Get the Tempcode for a date input, raw.
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: object

Parameters

Name Type Default Set Range Description
$name ID_TEXT required parameter N/A N/A The parameter name for this input field
$required boolean required parameter N/A N/A Whether this is a required field
$null_default boolean required parameter N/A N/A Whether this field is empty by default
$do_time boolean required parameter N/A N/A Whether to input time for this field also
$default_time ?mixed Null N/A N/A The default timestamp to use (either TIME or array of time components) (null: none) [ignored if $null_default is set]
$total_years_to_show ?integer 10 N/A N/A The number of years to allow selection from (pass a negative number for selection of past years instead of future years) (null: no limit)
$year_start ?integer Null N/A N/A The year to start counting $total_years_to_show from (null: if $total_years_to_show<0 then this year minus $total_years_to_show else if $total_years_to_show is not null then the current year else no restriction)
$tabindex ?integer Null N/A N/A The tab index of the field (null: not specified)
$do_date boolean True N/A N/A Whether to input date for this field (if false, will just do time)
$timezone ?ID_TEXT Null N/A N/A Timezone to input in (null: current user's timezone)
$handle_timezone boolean True N/A N/A Convert $default_time to $timezone
$autocomplete ~?mixed Null N/A N/A The autocomplete field name. (false: explicitly disable autocomplete) (null: no autocomplete attribute unless there's a default for this $name)
$read_only boolean False N/A N/A Whether this field should be disabled

Return

  • The input field
  • Type: Tempcode
  • Set: N/A
  • Range: N/A