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 Plugin()
$plugin->authors()

Returns the array with author information from the composer.json file
$plugin->authorsNames()

Returns a comma-separated list with all author names
$plugin->clone()

Creates an instance with the same initial properties.
$plugin->extends()

Returns the associative array of extensions the plugin bundles
$plugin->hardcopy()

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

Returns the unique ID for the plugin (alias for the plugin name)
$plugin->info()

Returns the raw data from composer.json
$plugin->kirby()

Returns the parent Kirby instance
$plugin->link()

Returns the link to the plugin homepage
$plugin->manifest()

Returns the path to the plugin's composer.json
$plugin->mediaRoot()

Returns the root where plugin assets are copied to
$plugin->mediaUrl()

Returns the base URL for plugin assets
$plugin->name()

Returns the plugin name (vendor/plugin)
$plugin->option()

Returns a Kirby option value for this plugin
$plugin->prefix()

Returns the option prefix (vendor.plugin)
$plugin->root()

Returns the root where the plugin files are stored
$plugin->setSite()

Setter for the parent site object
$plugin->site()

Returns the parent Site instance
$plugin->toArray()

Returns all available plugin metadata
$plugin->updateStatus()

Returns the update status object unless the update check has been disabled for the plugin
$plugin->version()

Returns the normalized version number from the composer.json file

$plugin->name()

Returns the plugin name (vendor/plugin)

kirby/src/Cms/Plugin.php#L159

$plugin->name(): string

Return type

string

Parent class

Kirby\Cms\Plugin

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