function hook_field_widget_properties_ENTITY_TYPE_alter

7.x field.api.php hook_field_widget_properties_ENTITY_TYPE_alter(&$widget, $context)

Alters the widget properties of a field instance on a given entity type before it gets displayed.

Modules can implement hook_field_widget_properties_ENTITY_TYPE_alter() to alter the widget properties for fields on a specific entity type, rather than implementing hook_field_widget_properties_alter().

This hook is called once per field per displayed widget 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_alter()

Related topics

1 function implements hook_field_widget_properties_ENTITY_TYPE_alter()

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

field_test_field_widget_properties_user_alter in drupal/modules/field/tests/field_test.module
Implements hook_field_widget_properties_ENTITY_TYPE_alter().

File

drupal/modules/field/field.api.php, line 2461
Hooks provided by the Field module.

Code

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