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

Constructor sets all file properties
$file->base64()

Returns the file content as base64 encoded string
$file->clone()

Creates an instance with the same initial properties.
$file->copy()

Copy a file to a new location.
$file->dataUri()

Returns the file as data uri
$file->delete()

Deletes the file
$file->download()
$file->exists()

Checks if the file actually exists
$file->extension()

Returns the current lowercase extension (without .)
$file->filename()

Returns the filename
$file->hardcopy()

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

Returns a md5 hash of the root
$file->header()

Sends an appropriate header for the asset
$file->html()

Converts the file to html
$file->is()

Checks if a file is of a certain type
$file->isReadable()

Checks if the file is readable
$file->isResizable()

Checks if the file is a resizable image
$file->isViewable()

Checks if a preview can be displayed for the file in the panel or in the frontend
$file->isWritable()

Checks if the file is writable
$file->kirby()

Returns the app instance if it exists
$file->match()

Runs a set of validations on the file object (mainly for images).
$file->mime()

Detects the mime type of the file
$file->model()

Returns the parent file model, which uses this instance as proxied file asset
$file->modified()

Returns the file's last modification time
$file->move()

Move the file to a new location
$file->name()

Getter for the name of the file without the extension
$file->niceSize()

Returns the file size in a human-readable format
$file->read()

Reads the file content and returns it.
$file->realpath()

Returns the absolute path to the file
$file->rename()

Changes the name of the file without touching the extension
$file->root()

Returns the given file path
$file->sanitizeContents()

Sanitizes the file contents depending on the file type by overwriting the file with the sanitized version
$file->sha1()

Returns the sha1 hash of the file
$file->size()

Returns the raw size of the file
$file->toArray()

Converts the media object to a plain PHP array
$file->toJson()

Converts the entire file array into a json string
$file->type()

Returns the file type.
$file->url()

Returns the absolute url for the file
$file->validateContents()

Validates the file contents depending on the file type
$file->write()

Writes content to the file

$file->root()

Returns the given file path

kirby/src/Filesystem/File.php#L433

$file->root(): string|null

Return type

string|null

Parent class

Kirby\Filesystem\File

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