W3cubDocs

/Drupal 8

public function OptionsProviderInterface::getSettableOptions

public OptionsProviderInterface::getSettableOptions(AccountInterface $account = NULL)

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.

File

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

Class

OptionsProviderInterface
Interface for retrieving all possible and settable values.

Namespace

Drupal\Core\TypedData

Code

public function getSettableOptions(AccountInterface $account = NULL);

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!TypedData!OptionsProviderInterface.php/function/OptionsProviderInterface::getSettableOptions/8.1.x