Documentation & API reference
function hook_form
Display a node editing form.
This hook, implemented by node modules, is called to retrieve the form that is displayed to create or edit a node. This form is displayed at path node/add/[node type] or node/[node ID]/edit.
The submit and preview buttons, administrative and display controls, and sections added by other modules (such as path settings, menu settings, comment settings, and fields managed by the Field UI module) are displayed automatically by the node module. This hook just needs to return the node title and form editing fields specific to the node type.
Parameters
\Drupal\Core\Entity\EntityInterface $node: The node being added or edited.
$form_state: The form state array.
Return value
An array containing the title and any custom form elements to be displayed in the node editing form.
Related topics
137 functions implement hook_form()
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
- aggregator_page_category_form in drupal/
core/ modules/ aggregator/ aggregator.pages.inc - Form constructor to list items aggregated in a category.
- aggregator_page_source_form in drupal/
core/ modules/ aggregator/ aggregator.pages.inc - Form constructor to show all items captured from a feed.
- ajax_forms_test_ajax_commands_form in drupal/
core/ modules/ system/ tests/ modules/ ajax_forms_test/ ajax_forms_test.module - Form constructor for the Ajax Command display form.
- ajax_forms_test_lazy_load_form in drupal/
core/ modules/ system/ tests/ modules/ ajax_forms_test/ ajax_forms_test.module - Form builder: Builds a form that triggers a simple AJAX callback.
- ajax_forms_test_simple_form in drupal/
core/ modules/ system/ tests/ modules/ ajax_forms_test/ ajax_forms_test.module - Tests form_state['values'] during callback.
File
- drupal/
core/ modules/ node/ node.api.php, line 1108 - Hooks provided by the Node module.
Code
function hook_form(\Drupal\Core\Entity\EntityInterface $node, &$form_state) {
$type = node_type_load($node->type);
$form['title'] = array(
'#type' => 'textfield',
'#title' => check_plain($type->title_label),
'#default_value' => !empty($node->title) ? $node->title : '',
'#required' => TRUE,
'#weight' => -5,
);
$form['field1'] = array(
'#type' => 'textfield',
'#title' => t('Custom field'),
'#default_value' => $node->field1,
'#maxlength' => 127,
);
$form['selectbox'] = array(
'#type' => 'select',
'#title' => t('Select box'),
'#default_value' => $node->selectbox,
'#options' => array(
1 => 'Option A',
2 => 'Option B',
3 => 'Option C',
),
'#description' => t('Choose an option.'),
);
return $form;
}