function field_widget_instance

Retrieves the instance definition array for a widget's helper callbacks.

Widgets helper element callbacks (such as #process, #element_validate, #value_callback, ...) should use field_widget_field() and field_widget_instance() instead of field_info_field() and field_info_instance() when they need to access field or instance properties. See hook_field_widget_form() for more details.

Parameters

$element: The structured array for the widget.

$form_state: The form state.

Return value

The $instance definition array for the current widget.

See also

field_widget_field()

hook_field_widget_form()

3 calls to field_widget_instance()
file_field_widget_process in modules/file/file.field.inc
An element #process callback for the file_generic field type.
image_field_widget_process in modules/image/image.field.inc
An element #process callback for the image_image field type.
number_field_widget_validate in modules/field/modules/number/number.module
FAPI validation of an individual number element.

File

modules/field/field.form.inc, line 612

Code

function field_widget_instance($element, $form_state) {
    $field_state = field_form_get_state($element['#field_parents'], $element['#field_name'], $element['#language'], $form_state);
    return $field_state['instance'];
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.