Skip to content

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- License Hub
Community
Partners

Try
Buy

View all results ›

Formatting 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
- Config options
- Urls
- Roots
- Requirements
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- QrCode
- Query
- Str
- Tpl
- Url
- V
- Xml

new Language()

Creates a new language object
$language->baseUrl()

Returns the base Url for the language without the path or other cruft
$language->clone()

Creates an instance with the same initial properties.
$language->code()

Returns the language code/id. The language code is used in text file names as appendix.
Language::create()

Creates a new language object
$language->delete()

Delete the current language and all its translation files
$language->direction()

Reading direction of this language
Language::ensure()

Converts a "user-facing" language code to a Language object
$language->exists()

Check if the language file exists
$language->hasNext()

Checks if there's a next item in the collection
$language->hasPrev()

Checks if there's a previous item in the collection
$language->id()

The id is required for collections to work properly. The code is used as id
$language->indexOf()

Returns the position / index in the collection
$language->is()

Checks if the language is the same as the given language or language code
$language->isDefault()

Checks if this is the default language for the site.
$language->isDeletable()

Checks if the language can be deleted
$language->isFirst()

Checks if the item is the first in the collection
$language->isLast()

Checks if this is the last language
$language->isNth()

Checks if the item is at a certain position
$language->isSingle()

Checks if this is the single language object
$language->kirby()

Returns the parent Kirby instance
Language::loadRules()

Loads the language rules for provided locale code
$language->locale()

Returns the PHP locale setting array
$language->name()

Returns the human-readable name of the language
$language->next()

Returns the next item in the collection if available
$language->nextAll()

Returns the end of the collection starting after the current item
$language->path()

Returns the URL path for the language
$language->pattern()

Returns the routing pattern for the language
$language->permissions()

Returns the permissions object for this language
$language->prev()

Returns the previous item in the collection if available
$language->prevAll()

Returns the beginning of the collection before the current item
$language->root()

Returns the absolute path to the language file
$language->router()

Returns the LanguageRouter instance which is used to handle language specific routes.
$language->rules()

Get slug rules for language
$language->save()

Saves the language settings in the languages folder
$language->siblings()

Returns all sibling elements
Language::single()

Create a placeholder language object in a single-language installation
$language->slugs()

Returns the custom slug rules for this language
$language->smartypants()

Returns the custom SmartyPants options for this language
$language->toArray()

Returns the most important properties as array
$language->translations()

Returns the translation strings for this language
$language->update()

Update language properties and save them
$language->url()

Returns the absolute Url for the language
$language->variable()

Returns a language variable object for the key in the translations array

$language->rules()

Get slug rules for language

kirby/src/Cms/Language.php#L469

$language->rules(): array

Return type

array

Parent class

Kirby\Cms\Language

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

Report an issue on this page on GitHub

Kirby

The CMS that adapts to any project. Made for developers, designers, creators and clients.

🇪🇺 Made in Europe

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- Pixels
- License Hub
Community
Kirby
- Security
- Privacy
- License
- Presskit
- Team
- Contact
With support of