Skip to content

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

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

Creates a new Request object You can either pass your own request data via the $options array or use the data from the incoming request.
$request->auth()

Returns the Auth object if authentication is set
$request->body()

Returns the Body object
$request->cli()

Checks if the request has been made from the command line
$request->csrf()

Returns a CSRF token if stored in a header or the query
$request->data()

Returns the request input as array
$request->detectRequestMethod()

Detect the request method from various options: given method, query string, server vars
$request->domain()

Returns the domain
$request->file()

Fetches a single file array from the Files object by key
$request->files()

Returns the Files object
$request->get()

Returns any data field from the request if it exists
$request->hasAuth()

Returns whether the request contains the Authorization header
$request->header()

Returns a header by key if it exists
$request->headers()

Return all headers with polyfill for missing getallheaders function
$request->is()

Checks if the given method name matches the name of the request method.
$request->method()

Returns the request method
$request->params()

Shortcut to the Params object
$request->path()

Shortcut to the Path object
$request->query()

Returns the Query object
$request->ssl()

Checks for a valid SSL connection
$request->url()

Returns the current Uri object.

$request->cli()

Checks if the request has been made from the command line

kirby/src/Http/Request.php#L180

$request->cli(): bool

Return type

bool

Parent class

Kirby\Http\Request

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