Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Plugins
- Themes
- Newsletter
- Buzz
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Fields
- Sections
- Blocks
- Icons
- Styling
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $block
- $blocks
- $layout
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Options
- Urls
- Roots
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- Query
- Str
- Tpl
- Url
- V
- Xml

new Role()
Role::admin()
$role->clone()

Creates an instance with the same initial properties.
$role->description()
Role::factory()
$role->hardcopy()

Creates a clone and fetches all lazy-loaded getters to get a full copy
$role->id()
$role->isAdmin()
$role->isNobody()
$role->kirby()

Returns the parent Kirby instance
Role::load()
$role->name()
Role::nobody()
$role->permissions()
$role->setSite()

Setter for the parent site object
$role->site()

Returns the parent Site instance
$role->title()
$role->toArray()

Converts the most important role properties to an array

$role->name()

kirby/src/Cms/Role.php#L142

$role->name(): string

Return type

string

Parent class

Kirby\Cms\Role

Did you find an error? Help us improve our docs and edit this page on Github. Make sure to check out our styleguide →