public function PermissionHandlerInterface::getPermissions in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/user/src/PermissionHandlerInterface.php \Drupal\user\PermissionHandlerInterface::getPermissions()
2. 9 core/modules/user/src/PermissionHandlerInterface.php \Drupal\user\PermissionHandlerInterface::getPermissions()

Gets all available permissions.

Return value

array An array whose keys are permission names and whose corresponding values are arrays containing the following key-value pairs:

• title: The human-readable name of the permission, to be shown on the permission administration page. This should be wrapped in the t() function so it can be translated.
• description: (optional) A description of what the permission does. This should be wrapped in the t() function so it can be translated.
• restrict access: (optional) A boolean which can be set to TRUE to indicate that site administrators should restrict access to this permission to trusted users. This should be used for permissions that have inherent security risks across a variety of potential use cases (for example, the "administer filters" and "bypass node access" permissions provided by Drupal core). When set to TRUE, a standard warning message defined in user_admin_permissions() will be displayed with the permission on the permission administration page. Defaults to FALSE.
• warning: (optional) A translated warning message to display for this permission on the permission administration page. This warning overrides the automatic warning generated by 'restrict access' being set to TRUE. This should rarely be used, since it is important for all permissions to have a clear, consistent security warning that is the same across the site. Use the 'description' key instead to provide any information that is specific to the permission you are defining.
• dependencies: (optional) An array of dependency entities used when building this permission, structured in the same way as the return of ConfigEntityInterface::calculateDependencies(). For example, if this permission was generated as effect of the existence of node type 'article', then value of the dependency key is:

    'dependencies' => ['config' => ['node.type.article']]
    

The module providing this permission doesn't have to be added as a dependency. It is automatically parsed, stored and retrieved from the 'provider' key.

• provider: The provider name of the permission. This is set automatically to the module that provides the permission.yml file.

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

File

core/modules/user/src/PermissionHandlerInterface.php, line 53

Class

PermissionHandlerInterface

Defines an interface to list available permissions.

Namespace

Drupal\user

Code

public function getPermissions();