Back

hourSelectTag()

Builds and returns a <select> form control for choosing an hour of the day. By default, hours are shown in 24-hour format (00–23), but you can switch to 12-hour format with an accompanying AM/PM dropdown.

Name Type Required Default Description
name string Yes Name to populate in tag's name attribute.
selected string No The day that should be selected initially.
includeBlank any No false Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
label string No The label text to use in the form control.
labelPlacement string No around Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using aroundLeft or aroundRight.
prepend string No String to prepend to the form control. Useful to wrap the form control with HTML tags.
append string No String to append to the form control. Useful to wrap the form control with HTML tags.
prependToLabel string No String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
appendToLabel string No String to append to the form control's label. Useful to wrap the form control with HTML tags.
twelveHour boolean No false whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs
encode any No true Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content. 
1. Basic 24-hour select
#hourSelectTag(name="meetingHour")#

// Output (simplified):
// <select name="meetingHour">
//   <option value="00">00</option>
//   <option value="01">01</option>
//   ...
//   <option value="23">23</option>
// </select>

2. Pre-select an hour
#hourSelectTag(name="meetingHour", selected="14")#

// Output (simplified):
// <option value="14" selected="selected">14</option>

3. Include a blank option
#hourSelectTag(name="meetingHour", includeBlank="- Select Hour -")#

// Output (simplified):
// <option value="">- Select Hour -</option>
// <option value="00">00</option>
// ...

4. Use 12-hour format with AM/PM
#hourSelectTag(name="meetingHour", twelveHour=true, selected="3")#

// Output (simplified):
// <select name="meetingHour">
//   <option value="01">01</option>
//   <option value="02">02</option>
//   <option value="03" selected="selected">03</option>
//   ...
//   <option value="12">12</option>
// </select>

// <select name="meetingHourMeridian">
//   <option value="AM">AM</option>
//   <option value="PM">PM</option>
// </select>
Copied!