1 vertical_tabs_example.module | vertical_tabs_example_form_alter(&$form, $form_state, $form_id) |
Implements hook_form_alter().
Adds custom fieldset to the node form, and attach ajax behaviour for vertical panels to update the settings description.
See also
vertical_tabs_example.js
Related topics
File
- modules/
examples/ vertical_tabs_example/ vertical_tabs_example.module, line 42 - Hook implementations for the Vertical Tabs Example module.
Code
function vertical_tabs_example_form_alter(&$form, $form_state, $form_id) {
// Only include on node add/edit forms.
if (isset($form['#node']) && $form['#node']->type . '_node_form' == $form_id) {
// Create a fieldset that will be included in the vertical tab.
$form['vertical_tabs_example'] = array(
'#type' => 'fieldset',
'#title' => t('Example vertical tab'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#tree' => TRUE,
// Send this tab to the top of the list.
'#weight' => -99,
// The #group value must match the name of the vertical tabs element.
// In most cases, this is 'additional_settings'.
'#group' => 'additional_settings',
// Vertical tabs provide its most usable appearance when they are used to
// include a summary of the information contained in the fieldset. To do
// this, we attach additional JavaScript to handle changing the summary
// when form settings are changed.
'#attached' => array(
'js' => array(
'vertical-tabs' => backdrop_get_path('module', 'vertical_tabs_example') . '/vertical_tabs_example.js',
),
),
);
// The form elements below provide a demonstration of how a fieldset
// summary can be displayed in a collapsed tab.
//
// This checkbox is used to show or hide the custom settings form using
// JavaScript (altering states of a container defined later).
$form['vertical_tabs_example']['enabled'] = array(
'#type' => 'checkbox',
'#title' => t('Change this setting'),
'#default_value' => FALSE,
);
// This container will be used to store the whole form for our custom
// settings. This way, showing/hiding the form using JavaScript is easier,
// as only one element should be set visible.
$form['vertical_tabs_example']['vertical_tabs_examplecontainer'] = array(
'#type' => 'container',
'#parents' => array('vertical_tabs_example'),
'#states' => array(
'invisible' => array(
// If the checkbox is not enabled, show the container.
'input[name="vertical_tabs_example[enabled]"]' => array('checked' => FALSE),
),
),
);
// The string of this textfield will be shown as summary in the vertical
// tab.
$form['vertical_tabs_example']['vertical_tabs_examplecontainer']['custom_setting'] = array(
'#type' => 'textfield',
'#title' => t('Use this setting instead'),
'#default_value' => 'I am a setting with a summary',
'#description' => t('As you type into this field, the summary will be updated in the tab.'),
);
}
}