hook_options_list_alter(array &$options, array $context)
Alters the list of options to be displayed for a field.
This hook can notably be used to change the label of the empty option.
Parameters
array $options: The array of options for the field, as returned by \Drupal\Core\TypedData\OptionsProviderInterface::getSettableOptions(). An empty option (_none) might have been added, depending on the field properties.
array $context: An associative array containing:
- fieldDefinition: The field definition (\Drupal\Core\Field\FieldDefinitionInterface).
- entity: The entity object the field is attached to (\Drupal\Core\Entity\EntityInterface).
See also
hook_options_list()
Related topics
- Hooks
- Define functions that alter the behavior of Drupal core.
File
- core/modules/options/options.api.php, line 31
- Hooks provided by the Options module.
Code
1 2 3 4 5 6 7 | function hook_options_list_alter( array & $options , array $context ) { // Check if this is the field we want to change. if ( $context [ 'fieldDefinition' ]->id() == 'field_option' ) { // Change the label of the empty option. $options [ '_none' ] = t( '== Empty ==' ); } } |
Please login to continue.