1 field.api.php hook_field_widget_properties_alter(&$widget, $context)

Alters the widget properties of a field instance before it gets displayed.

Note that instead of hook_field_widget_properties_alter(), which is called for all fields on all entity types, hook_field_widget_properties_ENTITY_TYPE_alter() may be used to alter widget properties for fields on a specific entity type only.

This hook is called once per field per added or edit entity. If the result of the hook involves reading from the database, it is highly recommended to statically cache the information.

Parameters

$widget: The instance's widget properties.

$context: An associative array containing:

  • entity_type: The entity type; e.g., 'node' or 'user'.
  • entity: The entity object.
  • field: The field that the widget belongs to.
  • instance: The instance of the field.

See also

hook_field_widget_properties_ENTITY_TYPE_alter()

Related topics

Field Widget API Define Field API widget types. Hooks Allow modules to interact with the Backdrop core.

File

core/modules/field/field.api.php, line 997
Hooks provided by the Field module.

Code

function hook_field_widget_properties_alter(&$widget, $context) {
  // Change a widget's type according to the time of day.
  $field = $context['field'];
  if ($context['entity_type'] == 'node' && $field['field_name'] == 'field_foo') {
    $time = date('H');
    $widget['type'] = $time < 12 ? 'widget_am' : 'widget_pm';
  }
}