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

Creates a new Asset object for the given path.
$asset->asset()

Returns the file asset object
$asset->blur()

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

Converts the image to black and white
$asset->clone()

Creates an instance with the same initial properties.
$asset->crop()

Crops the image by the given width and height
$asset->exists()

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

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

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

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

Returns a unique id for the asset
$asset->kirby()

Returns the app instance
$asset->mediaHash()

Create a unique media hash
$asset->mediaPath()

Returns the relative path starting at the media folder
$asset->mediaRoot()

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

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

Returns the path of the file from the web root, excluding the filename
$asset->quality()

Sets the JPEG compression quality
$asset->resize()

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

Returns the given file path
$asset->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.
$asset->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.
$asset->type()

Returns the file type
$asset->url()

Returns the absolute url for the file

$asset->kirby()

Returns the app instance

kirby/src/Filesystem/IsFile.php#L135

$asset->kirby(): Kirby\Cms\App

Return type

Kirby\Cms\App

Parent class

Kirby\Filesystem\Asset

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