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

Creates a new Filename object
$filename->attributesToArray()

Converts all processed attributes to an array. The array keys are already the shortened versions for the filename
$filename->attributesToString()

Converts all processed attributes to a string, that can be used in the new filename
$filename->blur()

Normalizes the blur option value
$filename->crop()

Normalizes the crop option value
$filename->dimensions()

Returns a normalized array with width and height values if available
$filename->extension()

Returns the sanitized extension
$filename->grayscale()

Normalizes the grayscale option value and also the available ways to write the option. You can use grayscale, greyscale or simply bw. The function will always return grayscale
$filename->name()

Returns the filename without extension
$filename->quality()

Normalizes the quality option value
$filename->toString()

Returns the converted filename as string

$filename->crop()

Normalizes the crop option value

kirby/src/Cms/Filename.php#L177

$filename->crop(): false|string

Return type

false|string

Parent class

Kirby\Cms\Filename

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