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 Api()

Creates a new API instance
$api->authenticate()

Runs the authentication method if set
$api->authentication()

Returns the authentication callback
$api->call()

Execute an API call for the given path, request method and optional request data
$api->clone()

Creates an instance with the same initial properties.
$api->collection()

Setter and getter for an API collection
$api->collections()

Returns the collections definition
$api->data()

Returns the injected data array or certain parts of it by key
$api->debug()

Returns the debugging flag
$api->fieldApi()
$api->file()

Returns the file object for the given parent path and filename
$api->hardcopy()

Creates a clone and fetches all lazy-loaded getters to get a full copy
$api->hasData()

Checks if injected data exists for the given key
$api->kirby()

Returns the Kirby instance
$api->language()

Returns the language request header
$api->model()

Returns an API model instance by name
$api->models()

Returns all model definitions
$api->page()

Returns the page object for the given id
$api->pages()

Returns the subpages for the given parent. The subpages can be filtered by status (draft, listed, unlisted, published, all)
$api->parent()

Returns the model's object for the given path
$api->render()

Renders the API call
$api->requestBody()

Returns the request body if available
$api->requestData()

Getter for request data Can either get all the data or certain parts of it.
$api->requestFiles()

Returns the files from the request if available
$api->requestHeaders()

Returns all headers from the request if available
$api->requestMethod()

Returns the request method
$api->requestQuery()

Returns the request query if available
$api->resolve()

Turns a Kirby object into an API model or collection representation
$api->responseForException()

Creates the response array for an exception. Kirby exceptions will have more information
$api->responseFor200()

Returns a 200 - ok response array.
$api->responseFor400()

Returns a 400 - bad request response array.
$api->responseFor404()

Returns a 404 - not found response array.
$api->routes()

Returns all defined routes
$api->searchPages()

Search for direct subpages of the given parent
$api->session()

Returns the current Session instance
$api->site()

Returns the site object
$api->upload()

Upload helper method
$api->user()

Returns the user object for the given id or returns the current authenticated user if no id is passed
$api->users()

Returns the users collection

$api->language()

Returns the language request header

kirby/src/Cms/Api.php#L101

$api->language(): string|null

Return type

string|null

Parent class

Kirby\Cms\Api

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