<?php
$form['high_school']['tests_taken'] = array(
'#type' => 'checkboxes',
'#options' => drupal_map_assoc(array(t('SAT'), t('ACT'))),
'#title' => t('What standardized tests did you take?'),
...
),
?>Description: +Format a color input element. #default_value uses the six digit hex color format, for example #0779bf.
+ +Properties: + #access, #after_build, #ajax, #array_parents, #attached, #attributes, + #default_value, #description, #disabled, + #element_validate, #parents, + #post_render, #prefix, + #pre_render, #process, + #required, #states, + #suffix, #theme, #theme_wrappers, + #title, #title_display, + #tree, #type, + #value_callback, #weight
+ +Usage example:
+<?php
$form['color'] = array(
'#type' => 'color',
'#title' => t('Color'),
'#default_value' => '#0779bf',
);
?>Description: Returns HTML to wrap child elements in a container. Surrounds child elements with a <div> and -adds attributes such as classes or an HTML id. +adds attributes such as classes or an HTML id.
Properties:
#access, #after_build, #attributes
@@ -1994,6 +3009,66 @@ $fields[$category);
?>
+datelist
+
Description: + Format a collection of individual date and/or time fields. #date_part_order determines which date or time fields will be in the form and their order. Available options: 'month', 'day', 'year', 'hour', 'minute', 'ampm'. + By default a pull-down list is used for the fields. With #date_text_parts, individual fields can be changed into text fields. + More information: datetime_datelist_form_process(). +
+ +Properties: + #access, #after_build, + #array_parents, #attached, #attributes, + #default_value, #description, + #disabled, #date_date_callbacks, + #date_increment (default: 1), + #date_part_order (default: array('minute')), + #date_timezone, + #date_year_range (default: '1900:2050'), + #element_validate, #parents, #post_render, + #prefix, #pre_render, #process, + #required, #states, + #suffix, #theme, #theme_wrappers, + #title, #title_display, + #tree, #type, + #value_callback, #weight
+ +Usage example:
+<?php
$form['date'] = array(
'#type' => 'datelist',
'#default_value' => new DrupalDateTime('2000-01-01 00:00:00'),
'#date_part_order' => array('month', 'day', 'year', 'hour', 'minute', 'ampm'),
'#date_text_parts' => array('year'),
'#date_year_range' => '2010:2020',
'#date_increment' => 15,
);
?>Description: + Format a date and/or time field. #date_date_element determines the type of field which is used for date input. Available options: 'datetime', 'datetime-local', 'date', 'text', 'none'. + Similarly, #date_time_element determines the type of field which is used for time input. Available options: 'time', 'text', 'none'. + More information: datetime_datetime_form_process(). +
+ +Properties: + #access, #after_build, + #array_parents, #attached, #attributes, + #default_value, #description, + #disabled, #date_date_callbacks, + #date_date_callbacks, + #date_date_element (default: 'date'), + #date_date_format (default: 'Y-m-d'), + #date_format_string_type (default: 'php'), + #date_increment (default: 1), + #date_time_callbacks, + #date_time_element (default: 'time'), + #date_time_format (default: 'H:i:s'), + #date_timezone, + #date_year_range (default: '1900:2050'), + #element_validate, #parents, #post_render, + #prefix, #pre_render, #process, + #required, #states, + #suffix, #theme, #theme_wrappers, + #title, #title_display, + #tree, #type, + #value_callback, #weight
+ +Usage example:
+<?php
$form['date'] = array(
'#type' => 'datetime',
'#default_value' => new DrupalDateTime('2000-01-01 00:00:00'),
'#date_date_element' => 'date',
'#date_time_element' => 'none',
'#date_year_range' => '2010:+3',
);
?>Description:
@@ -2022,6 +3097,25 @@ $form['book'] = array(
);
+
Description: Format an email form field.
+ +Properties: + #access, #after_build, #ajax, #array_parents, + #attached, #attributes, #autocomplete_path, + #default_value, #description, #disabled, + #element_validate, #maxlength (default: 254), #parents, + #post_render, #prefix, + #pre_render, #process, + #required, #states, #size (default: 60), + #suffix, #theme, #theme_wrappers, + #title, #title_display, + #tree, #type, + #value_callback, #weight
+ +Usage example (MessageFormController::form):
+<?php
$form['mail'] = array(
'#type' => 'email',
'#title' => t('Your e-mail address'),
'#required' => TRUE,
);
?>Description:
@@ -2329,6 +3423,29 @@ were actually required (i.e. by placing a red star next to the
+ Description:
+ Format a number input element. Properties:
+ #access, #after_build, #ajax,
+ #array_parents, #attached,
+ #attributes, #default_value,
+ #description, #disabled,
+ #element_validate, #max,
+ #maxlength, #min,
+ #parents, #post_render,
+ #prefix, #pre_render,
+ #process, #required, #states,
+ #step (default: 1), #suffix,
+ #theme, #theme_wrappers,
+ #title, #title_display,
+ #tree, #type,
+ #value_callback, #weight Usage example (EditorImageDialog::buildForm): Description: Generate
@@ -2452,6 +3569,52 @@ radio button. Description:
+ Format a range input element. Depending on your browser, an HTML5 range element may be displayed as a slider. Properties:
+ #access, #after_build, #ajax,
+ #array_parents, #attached,
+ #attributes, #default_value,
+ #description, #disabled,
+ #element_validate, #max,
+ #min, #parents,
+ #post_render, #prefix,
+ #pre_render, #process,
+ #required, #states,
+ #step (default: 1), #suffix,
+ #theme, #theme_wrappers,
+ #title, #title_display,
+ #tree, #type,
+ #value_callback, #weight Usage example (form_test.module): Description:
+ Format a search field. Properties:
+ #access, #after_build, #ajax,
+ #array_parents, #attached,
+ #attributes, #autocomplete_path,
+ #default_value, #description,
+ #disabled, #element_validate,
+ #field_prefix, #field_suffix,
+ #maxlength (default: 128), #parents,
+ #placeholder, #post_render,
+ #prefix, #pre_render, #process,
+ #required, #size (default: 60),
+ #states, #suffix, #theme,
+ #theme_wrappers, #title,
+ #title_display, #tree, #type,
+ #weight, #value_callback Usage example: Description: Format a drop-down menu or scrolling selection box.
@@ -2500,36 +3663,50 @@ of various settings for a select element, including behavior if #required is TRU
$form['submit'] = array('#type' => 'submit', '#value' => t('Import')); Description: Description:
-A table created with a far left column of radios or checkboxes. Build the table headings and
-columns with the #headers property, and the rows with the #options property. See
-Adding checkboxes to a table
-for a full explanation. Other settings: Properties: #access, #after_build, #ajax, #attributes, #default_value,
-#element_validate, #empty,
-#header, #js_select, #multiple, #options,
-#parents, #post_render,
-#prefix, #pre_render, #process, #states,
-#suffix, #theme, #theme_wrappers,
-#tree, #type,
-#weight Usage example (node.admin.inc): Properties:
+ #access, #after_build, #ajax,
+ #array_parents, #attached,
+ #attributes, #default_value,
+ #element_validate, #empty,
+ #header, #js_select (default for checkboxes: TRUE),
+ #multiple (default: TRUE), #options,
+ #parents, #post_render,
+ #prefix, #pre_render, #process,
+ #responsive (default: TRUE), #states, #sticky
+ #suffix, #tabledrag,
+ #tableselect, #theme,
+ #theme_wrappers, #tree,
+ #type, #value_callback,
+ #weight Usage examples:number
+<?php
$form['dimensions']['height'] = array(
'#title' => $this->t('Height'),
'#title_display' => 'invisible',
'#type' => 'number',
'#default_value' => isset($image_element['height']) ? $image_element['height'] : '',
'#size' => 8,
'#maxlength' => 8,
'#min' => 1,
'#max' => 99999,
'#placeholder' => $this->t('height'),
'#field_suffix' => $this->t('pixels'),
'#parents' => array('attributes', 'height'),
);
?>markup
<?php
$active = array(0 => t('Closed'), 1 => t('Active'));
...
$form['settings']['active'] = array(
'#type' => 'radios',
'#title' => t('Poll status'),
'#default_value' => isset($node->active) ? $node->active : 1,
'#options' => $active,
'#description' => t('When a poll is closed, visitors can no longer vote for it.'),
'#access' => $admin,
);
?>range
+<?php
$form['integer'] = array(
'#type' => 'range',
'#title' => 'Integer',
'#min' => 2,
'#max' => 8,
'#step' => 2,
'#description' => 'Even integer between 2 and 8.',
);
?>search
+<?php
$form['search'] = array(
'#type' => 'search',
'#title' => $this->t('Search'),
'#title_display' => 'invisible',
'#placeholder' => $this->t('Enter your search'),
'#size' => 25,
);
?>select
?>
-tableselect
+table
+
+
-
+ Use the #tableselect attribute to enable selectable table rows. Rows can be selected using checkboxes or radio buttons depending on the #multiple attribute.
+ See Adding checkboxes to a table for more details..
+
+ Use the #tabledrag attribute to enable and configure draggable table rows.
+ See drupal_attach_tabledrag() for #tabledrag configuration details.
+
+ The #header attribute can be used for click sorting the content of the table.
+ See theme_table() for more information.
+
-
-<?php
// Build the sortable table header.
$header = array(
'title' => array('data' => t('Title'), 'field' => 'n.title'),
'type' => array('data' => t('Type'), 'field' => 'n.type'),
'author' => t('Author'),
'status' => array('data' => t('Status'), 'field' => 'n.status'),
'changed' => array('data' => t('Updated'), 'field' => 'n.changed', 'sort' => 'desc')
);
...
//Get the node data.
$nids = $query
->fields('n',array('nid'))
->limit(50)
->orderByHeader($header)
->execute()
->fetchCol();
$nodes = node_load_multiple($nids);
...
//Build the rows.
$options = array();
foreach ($nodes as $node) {
...
$options[$node->nid] = array(
'title' => array(
'data' => array(
'#type' => 'link',
'#title' => $node->title,
'#href' => 'node/' . $node->nid,
'#options' => $l_options,
'#suffix' => ' ' . theme('mark', array('type' => node_mark($node->nid, $node->changed))),
),
),
'type' => check_plain(node_type_get_name($node)),
'author' => theme('username', array('account' => $node)),
'status' => $node->status ? t('published') : t('not published'),
'changed' => format_date($node->changed, 'short'),
);
//For simplicity, this example omits the code to set the operations column.
...
//Build the tableselect.
$form['nodes'] = array(
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
'#empty' => t('No content available.'),
);
?><?php
/**
* Basic table
*/
$header = array('first', 'second');
$rows = array(
array('primera', 'secundo'),
array('eerste', 'tweede'),
array('1', '2'),
);
$form['table'] = array(
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#empty' => $this->t('No info available.'),
);
/**
* Table with dragable rows.
*
* @see \Drupal\Core\Config\Entity\DraggableListBuilder::buildForm()
*/
$header = array('Number', 'Character');
$rows = array(
1 => array(
'data' => array('1', 'A'),
'class' => array('draggable'),
),
2 => array(
'data' => array('2', 'B'),
'class' => array('draggable'),
),
3 => array(
'data' => array('3', 'C'),
'class' => array('draggable'),
),
);
$form['tabledrag'] = array(
'#type' => 'table',
'#header' => $header,
'#empty' => t('There is no label yet.'),
'#rows' => $rows,
'#tabledrag' => array(
array(
'action' => 'order',
'relationship' => 'sibling',
'group' => 'weight',
),
),
'#attributes' => array(
'id' => 'tqbledrag-table',
),
);
/**
* Table with selectable rows.
*/
$users = array(
array('uid' => 1, 'first_name' => 'Indy', 'last_name' => 'Jones'),
array('uid' => 2, 'first_name' => 'Darth', 'last_name' => 'Vader'),
array('uid' => 3, 'first_name' => 'Super', 'last_name' => 'Man'),
);
$header = array(
'first_name' => t('First Name'),
'last_name' => t('Last Name'),
);
$form['tableselect'] = array(
'#type' => 'table',
'#tableselect' => TRUE,
'#header' => $header,
'#empty' => t('No users found'),
);
foreach ($users as $user) {
$form['tableselect'][$user['uid']] = array(
'first_name' => array('#markup' => check_plain($user['first_name'])),
'last_name' => array('#markup' => check_plain($user['last_name'])),
);
}
?>text_format
@@ -2758,7 +3935,7 @@ be called after the form or element is built.
Used by: button, checkbox, checkboxes, image button, password, -radio, radios, select, submit, tableselect, textarea, text_format, +radio, radios, select, submit, table, textarea, text_format, textfield
An array of elements whose values control the behavior of the
@@ -3074,7 +4251,7 @@ $form['#attached']['js'][] = array(
'data' => array('mymodule' =
Used by: actions, button, checkbox, checkboxes, container, date, details, fieldset, file, form, image_button, password, -radio, radios, select, submit, tableselect, textarea, text_format, +radio, radios, select, submit, table, textarea, text_format, textfield, weight
Description: Additional HTML attributes, such as @@ -3255,7 +4432,7 @@ takes the form of "edit-ARRAY_KEY".
Used by: checkbox, checkboxes, -date, hidden, radio, radios, select, tableselect, textarea, +date, hidden, radio, radios, select, table, textarea, text_format, textfield, token, weight
Description: The value of the form element that @@ -3377,7 +4554,7 @@ over it, so in that case don't follow this usage example exactly.
Used by: tableselect
+Used by: table
Description: Text to display if the #options property is empty.
@@ -3527,7 +4704,7 @@ $form['email'#header -Used by: tableselect
+Used by: table
Description: Column headers.
@@ -3552,7 +4729,7 @@ element.Used by: tableselect
+Used by: table
Description: Whether to include a select all checkbox.
@@ -3655,7 +4832,7 @@ $form['#method'Used by: select, tableselect
+Description: Indicates whether the user may select more than one item.
@@ -3688,13 +4865,13 @@ more than one item.Used by: checkboxes, radios, select, tableselect
+Used by: checkboxes, radios, select, table
Description: Selectable options for a form element that allows multiple choices.
Values: An array in the form of array(t('Display value 1'), t('Display value 2')) or array('return_value1' => t('Display Value 1'), 'return_value2' => t('Display Value 2'))
if specific return values are required. If returned values are identical to displayed values, you can use drupal_map_assoc() as in the example below.
-The #options property needs special handling for checkboxes, and works completely differently for tableselect. See the respective element descriptions for details.
Usage example (form_example_states.inc):
@@ -4175,7 +5352,7 @@ element.Values: button, checkbox, checkboxes, date, details, fieldset, file, form, hidden, image_button, item, machine_name, markup, password, password_confirm, radio, -radios, select, submit, tableselect, textarea, textfield, token, value, vertical_tabs, weight
+radios, select, submit, table, textarea, textfield, token, value, vertical_tabs, weightUsage example (locale.module):