function FilterFormat::getSettableOptions

Same name and namespace in other branches
  1. 9 core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat::getSettableOptions()
  2. 8.9.x core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat::getSettableOptions()
  3. 10 core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat::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.

Overrides OptionsProviderInterface::getSettableOptions

1 call to FilterFormat::getSettableOptions()
FilterFormat::getSettableValues in core/modules/filter/src/Plugin/DataType/FilterFormat.php
Returns an array of settable values.

File

core/modules/filter/src/Plugin/DataType/FilterFormat.php, line 46

Class

FilterFormat
The filter format data type.

Namespace

Drupal\filter\Plugin\DataType

Code

public function getSettableOptions(?AccountInterface $account = NULL) {
  // @todo Avoid calling functions but move to injected dependencies.
  return array_map(function ($format) {
    return $format->label();
  }, filter_formats($account));
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.