FilterFormat::$roles

Same name and namespace in other branches
  1. 8.9.x core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat::roles
  2. 10 core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat::roles
  3. 11.x core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat::roles

List of user role IDs to grant access to use this format on initial creation.

This property is always empty and unused for existing text formats.

Default configuration objects of modules and installation profiles are allowed to specify a list of user role IDs to grant access to.

This property only has an effect when a new text format is created and the list is not empty. By default, no user role is allowed to use a new format.

Type: array

File

core/modules/filter/src/Entity/FilterFormat.php, line 103

Class

FilterFormat
Represents a text format.

Namespace

Drupal\filter\Entity

Code

protected $roles;

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