function hook_element_info

7.x system.api.php hook_element_info()
8.x system.api.php hook_element_info()

Allows modules to declare their own Form API element types and specify their default values.

This hook allows modules to declare their own form element types and to specify their default values. The values returned by this hook will be merged with the elements returned by hook_form() implementations and so can return defaults for any Form APIs keys in addition to those explicitly mentioned below.

Each of the form element types defined by this hook is assumed to have a matching theme function, e.g. theme_elementtype(), which should be registered with hook_theme() as normal.

For more information about custom element types see the explanation at http://drupal.org/node/169815.

Return value

An associative array describing the element types being defined. The array contains a sub-array for each element type, with the machine-readable type name as the key. Each sub-array has a number of possible attributes:

  • "#input": boolean indicating whether or not this element carries a value (even if it's hidden).
  • "#process": array of callback functions taking $element, $form_state, and $complete_form.
  • "#after_build": array of callback functions taking $element and $form_state.
  • "#validate": array of callback functions taking $form and $form_state.
  • "#element_validate": array of callback functions taking $element and $form_state.
  • "#pre_render": array of callback functions taking $element and $form_state.
  • "#post_render": array of callback functions taking $element and $form_state.
  • "#submit": array of callback functions taking $form and $form_state.
  • "#title_display": optional string indicating if and how #title should be displayed, see theme_form_element() and theme_form_element_label().

See also

hook_element_info_alter()

system_element_info()

Related topics

6 functions implement hook_element_info()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

contextual_element_info in drupal/modules/contextual/contextual.module
Implements hook_element_info().
field_ui_element_info in drupal/modules/field_ui/field_ui.module
Implements hook_element_info().
file_element_info in drupal/modules/file/file.module
Implements hook_element_info().
filter_element_info in drupal/modules/filter/filter.module
Implements hook_element_info().
system_element_info in drupal/modules/system/system.module
Implements hook_element_info().

... See full list

1 invocation of hook_element_info()
element_info in drupal/includes/common.inc
Retrieves the default properties for the defined element type.

File

drupal/modules/system/system.api.php, line 684
Hooks provided by Drupal core and the System module.

Code

function hook_element_info() {
  $types['filter_format'] = array(
    '#input' => TRUE,
  );
  return $types;
}