Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Newsletter
- Plugins
- Roadmap
- Releases
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Presets
- Fields
- Sections
- Blocks
- Icons
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $blocks
- $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
- Server
- Str
- Tpl
- Url
- V
- Xml

new File()

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

Returns the url to api endpoint
$file->asset()

Returns the Image object
$image->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
$file->blur()

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

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

Calls a registered method class with the passed arguments
$file->changeName()

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

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

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

Returns the content
$file->contentFile()

Returns the absolute path to the content file
$file->contentFileData()

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

Returns the directory in which the content file is located
$file->contentFileExtension()

Returns the extension of the content file
$file->contentFileName()

Filename for the content file
$file->contentFiles()

Returns an array with all content files
$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->crop()

Crops the image by the given width and height
$image->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
$image->download()
$file->dragText()

Provides a kirbytag or markdown tag for the file, which will be used in the panel, when the file gets dragged onto a textarea
$file->dragTextFromCallback()

Returns the drag text from a custom callback if the callback is defined in the config
$file->dragTextType()

Returns the correct drag text type depending on the given type or the configuration
$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 file extension
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 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
$image->hash()

Returns a md5 hash of the root
$image->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->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->isLocked()

Checks if the model is locked for the current user
$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
$image->isWritable()

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

Returns the app instance
$file->lock()

Returns the lock object for this model
$image->match()

Runs a set of validations on the image object
$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
$image->mime()

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

Get the file's last modification time.
$image->move()

Move the file to a new location
$image->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
$image->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->panelIcon()

Panel icon definition
$file->panelImage()
$file->panelOptions()

Returns an array of all actions that can be performed in the Panel
$file->panelPath()

Returns the full path without leading slash
$file->panelPickerData()

Prepares the response data for file pickers and file fields
$file->panelUrl()

Returns the url to the editing view in the panel
$file->parent()

Returns the parent Model object
$file->parentId()

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

Returns a collection of all parent pages
$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->publish()

Move the file to the public media folder if it's not already there.
$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
$image->read()

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

Read the content from the content file
$image->realpath()

Returns the absolute path to the file
$image->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.
$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->save()

Stores the content on disk
$file->setSite()

Setter for the parent site object
$file->siblings()

Returns all sibling elements
$file->site()

Returns the parent Site object
$image->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->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.
$image->toJson()

Converts the entire file array into a json string
$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 model data
$file->url()

Returns the Url
$image->validateContents()

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

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

Writes content to the file
$file->writeContent()

Low level data writer method to store the given data on disk or anywhere else

$file->parentId()

Returns the parent id if a parent exists

kirby/src/Cms/File.php#L617

$file->parentId(): string|null

Return type

string|null

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 →