function OptionsProviderInterface::getSettableOptions
Same name in other branches
- 9 core/lib/Drupal/Core/TypedData/OptionsProviderInterface.php \Drupal\Core\TypedData\OptionsProviderInterface::getSettableOptions()
- 8.9.x core/lib/Drupal/Core/TypedData/OptionsProviderInterface.php \Drupal\Core\TypedData\OptionsProviderInterface::getSettableOptions()
- 10 core/lib/Drupal/Core/TypedData/OptionsProviderInterface.php \Drupal\Core\TypedData\OptionsProviderInterface::getSettableOptions()
Returns an array of settable values with labels for display.
If the optional $account parameter is passed, then the array is filtered to values settable by the account.
Parameters
\Drupal\Core\Session\AccountInterface $account: (optional) The user account for which to filter the settable options. If omitted, all settable options are returned.
Return value
array An array of settable options for the object that may be used in an Options widget, usually when new data should be entered. It may either be a flat array of option labels keyed by values, or a two-dimensional array of option groups (array of flat option arrays, keyed by option group label). Note that labels should NOT be sanitized.
5 methods override OptionsProviderInterface::getSettableOptions()
- BooleanItem::getSettableOptions in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ BooleanItem.php - Returns an array of settable values with labels for display.
- EntityReferenceItem::getSettableOptions in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ EntityReferenceItem.php - Returns an array of settable values with labels for display.
- FilterFormat::getSettableOptions in core/
modules/ filter/ src/ Plugin/ DataType/ FilterFormat.php - Returns an array of settable values with labels for display.
- LanguageItem::getSettableOptions in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ LanguageItem.php - Returns an array of settable values with labels for display.
- ListItemBase::getSettableOptions in core/
modules/ options/ src/ Plugin/ Field/ FieldType/ ListItemBase.php - Returns an array of settable values with labels for display.
File
-
core/
lib/ Drupal/ Core/ TypedData/ OptionsProviderInterface.php, line 97
Class
- OptionsProviderInterface
- Interface for retrieving all possible and settable values.
Namespace
Drupal\Core\TypedDataCode
public function getSettableOptions(?AccountInterface $account = NULL);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.