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

Creates a new File object
$file->asset()

Returns the file asset object. A new object will be created if it doesn't exist yet. The instance will be cached to avoid multiple instantiations, when calling asset methods.
$file->base64()

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

Returns the FileBlueprint object for the file
$file->blueprints()

Returns an array with all blueprints that are available for the file by comparing files sections and files fields of the parent model
$file->blur()

Blurs the image by the given amount of pixels
$file->bw()

Converts the image to black and white
$file->changeName()

Renames the file (optionally also the extension). The store is used to actually execute this.
$file->changeSort()

Changes the file's sorting number in the meta file
$file->changeStorage()

Moves or copies the model to a new storage instance/type
$file->changeTemplate()
$file->clone()

Creates a new instance with the same initial properties
$file->content()

Returns the content
$file->contentFileData()

Store the template in addition to the other content.
$file->copy()

Copy the file to the given page
File::create()

Creates a new file on disk and returns the File object. The store is used to handle file writing, so it can be replaced by any other way of generating files.
$file->createDefaultContent()

Creates default content for the model, by using our Form class to generate the defaults, based on the model's blueprint setup.
$file->crop()

Crops the image by the given width and height
$file->dataUri()

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

Decrement a given field value
$file->delete()

Deletes the file. The store is used to manipulate the filesystem or whatever you prefer.
$image->dimensions()

Returns the dimensions of the file if possible
$file->download()
$file->errors()

Returns all content validation errors
$image->exif()

Returns the exif object for this file (if image)
$file->exists()

Checks if the file exists on disk
$file->extension()

Returns the current lowercase extension (without .)
File::factory()

Constructs a File object
$file->filename()

Returns the filename with extension
$file->files()

Returns the parent Files collection
$file->grayscale()

Alias for File::bw()
$file->greyscale()

Alias for File::bw()
$file->hardcopy()

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

Checks if the object has a registered custom method
$file->hasNext()

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

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

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

Sends an appropriate header for the asset
$image->height()

Returns the height of the asset
$file->html()

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

Returns the id
$image->imagesize()

Returns the PHP imagesize array
$file->increment()

Increment a given field value
$file->indexOf()

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

Compares the current object with the given file object
$file->isAccessible()

Checks if the file is accessible to the current user This permission depends on the read option until v6
$file->isFirst()

Checks if the item is the first in the collection
$image->isLandscape()

Checks if the dimensions of the asset are landscape
$file->isLast()

Checks if the item is the last in the collection
$file->isListable()

Check if the file can be listable by the current user This permission depends on the read option until v6
$file->isNth()

Checks if the item is at a certain position
$image->isPortrait()

Checks if the dimensions of the asset are portrait
$file->isReadable()

Check if the file can be read by the current user
$file->isResizable()

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

Checks if the dimensions of the asset are square
$file->isValid()

Checks if the data has any errors
$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
$file->lock()

Returns lock for the model
$file->manipulate()

Resizes/crops the original file with Kirby's thumb handler
$file->match()

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

Returns the absolute path to the media folder for the file and its versions
$file->mediaHash()

Creates a unique media hash
$file->mediaRoot()

Returns the absolute path to the file in the public media folder
$file->mediaToken()

Creates a non-guessable token string for this file
$file->mediaUrl()

Returns the absolute Url to the file in the public media folder
$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()

Get 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->next()

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

Returns the end of the collection starting after the current item
$file->niceSize()

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

Returns the orientation as string landscape | portrait | square
$file->page()

Returns the parent Page object
$file->panel()

Returns the panel info object
$file->parent()

Returns the parent object
$file->parentId()

Returns the parent id if a parent exists
$file->parents()

Returns a collection of all parent pages
$file->permalink()

Return the permanent URL to the file using its UUID
$file->permissions()

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

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

Returns the beginning of the collection before the current item
$file->previewUrl()

Clean file URL that uses the parent page URL and the filename as a more stable alternative for the media URLs if available. The content.fileRedirects option is used to disable this behavior or enable it on a per-file basis.
$file->publish()

Move the file to the public media folder if it's not already there.
$file->purge()

Clean internal caches
$file->quality()

Sets the JPEG compression quality
$file->query()

Creates a string query, starting from the model
$image->ratio()

Returns the ratio of the asset
$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->replace()

Replaces the file. The source must be an absolute path to a file or a Url. The store handles the replacement so it finally decides what it will support as source.
$file->resize()

Resizes the file with the given width and height while keeping the aspect ratio.
$file->root()

Returns the absolute root to the file
$file->sanitizeContents()

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

Low-level method to save the model with the given data. Consider using ::update() instead.
$file->sha1()

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

Sharpens the image
$file->siblings()

Returns all sibling elements
$file->site()

Returns the parent Site object
$file->size()

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

Create a srcset definition for the given sizes Sizes can be defined as a simple array. They can also be set up in the config with the thumbs.srcsets option.
$file->storage()

Returns the content storage handler
$file->template()

Returns the final template
$file->templateSiblings()

Returns siblings with the same template
$file->thumb()

Creates a modified version of images The media manager takes care of generating those modified versions and putting them in the right place. This is normally the /media folder of your installation, but could potentially also be a CDN or any other place.
$file->toArray()

Extended info for the array export by injecting the information from the asset.
$file->toJson()

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

String template builder with automatic HTML escaping
$file->toString()

String template builder
$file->translation()

Returns a single translation by language code If no code is specified the current translation is returned
$file->translations()

Returns the translations collection
$file->type()

Returns the file type
$file->unpublish()

Remove all public versions of this file
$file->update()

Updates the file's data and ensures that media files get wiped if focus changed
$file->url()

Returns the Url
$file->uuid()

Return the file's Unique ID.
$file->validateContents()

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

Returns a content version instance
$file->versions()

Returns a versions collection
$image->width()

Returns the width of the asset
$file->write()

Writes content to the file

$file->panel()

Returns the panel info object

kirby/src/Cms/File.php#L474

$file->panel(): Kirby\Panel\File

Return type

Kirby\Panel\File

Parent class

Kirby\Cms\File

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