Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/TypedData/OptionsProviderInterface.php \Drupal\Core\TypedData\OptionsProviderInterface::getPossibleOptions()
  2. 9 core/lib/Drupal/Core/TypedData/OptionsProviderInterface.php \Drupal\Core\TypedData\OptionsProviderInterface::getPossibleOptions()

Returns an array of possible values with labels for display.

If the optional $account parameter is passed, then the array is filtered to values viewable by the account.

Parameters

\Drupal\Core\Session\AccountInterface $account: (optional) The user account for which to filter the possible options. If omitted, all possible options are returned.

Return value

array An array of possible options for the object that may be used in an Options widget, for example when existing data should be filtered. 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.

2 methods override OptionsProviderInterface::getPossibleOptions()
BooleanItem::getPossibleOptions in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/BooleanItem.php
Returns an array of possible values with labels for display.
LanguageItem::getPossibleOptions in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/LanguageItem.php
Returns an array of possible values with labels for display.

File

core/lib/Drupal/Core/TypedData/OptionsProviderInterface.php, line 63

Class

OptionsProviderInterface
Interface for retrieving all possible and settable values.

Namespace

Drupal\Core\TypedData

Code

public function getPossibleOptions(AccountInterface $account = NULL);