Trait craft\base\PluginTrait
- Implemented by
- craft\base\Plugin
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/base/PluginTrait.php
PluginTrait implements the common methods and properties for plugin classes.
| Property | Type | Description | Defined By |
|---|---|---|---|
$changelogUrl |
string, null | The plugin’s changelog URL | craft\base\PluginTrait |
$description |
string, null | The plugin’s description | craft\base\PluginTrait |
$developer |
string, null | The plugin developer’s name | craft\base\PluginTrait |
$developerEmail |
string, null | The plugin developer’s support email | craft\base\PluginTrait |
$developerUrl |
string, null | The plugin developer’s website URL | craft\base\PluginTrait |
$documentationUrl |
string, null | The plugin’s documentation URL | craft\base\PluginTrait |
$downloadUrl |
string, null | The plugin’s download URL | craft\base\PluginTrait |
$hasCpSection |
boolean | Whether the plugin has its own section in the CP | craft\base\PluginTrait |
$hasCpSettings |
boolean | Whether the plugin has a settings page in the CP | craft\base\PluginTrait |
$isInstalled |
boolean | Whether the plugin is currently installed. | craft\base\PluginTrait |
$minVersionRequired |
string | The minimum required version the plugin has to be so it can be updated. | craft\base\PluginTrait |
$name |
string, null | The plugin’s display name | craft\base\PluginTrait |
$packageName |
string, null | The plugin’s package name | craft\base\PluginTrait |
$schemaVersion |
string, null | The plugin’s schema version number | craft\base\PluginTrait |
$sourceLanguage |
string | The language that the plugin’s messages were written in | craft\base\PluginTrait |
$t9nCategory |
string, null | The translation category that this plugin’s translation messages should use. | craft\base\PluginTrait |
Property Details
$changelogUrl
public property
#
The plugin’s changelog URL
public string, null $changelogUrl = null
$description
public property
#
The plugin’s description
public string, null $description = null
$developer
public property
#
The plugin developer’s name
public string, null $developer = null
$developerEmail
public property
#
The plugin developer’s support email
public string, null $developerEmail = null
$developerUrl
public property
#
The plugin developer’s website URL
public string, null $developerUrl = null
$documentationUrl
public property
#
The plugin’s documentation URL
public string, null $documentationUrl = null
$downloadUrl
public property
#
The plugin’s download URL
public string, null $downloadUrl = null
$hasCpSection
public property
#
Whether the plugin has its own section in the CP
public boolean $hasCpSection = false
$hasCpSettings
public property
#
Whether the plugin has a settings page in the CP
public boolean $hasCpSettings = false
$isInstalled
public property
#
Whether the plugin is currently installed. (Will only be false when a plugin is currently being installed.)
public boolean $isInstalled = false
$minVersionRequired
public property
#
The minimum required version the plugin has to be so it can be updated.
public string $minVersionRequired = null
$name
public property
#
The plugin’s display name
public string, null $name = null
$packageName
public property
#
The plugin’s package name
public string, null $packageName = null
$schemaVersion
public property
#
The plugin’s schema version number
public string, null $schemaVersion = '1.0.0'
$sourceLanguage
public property
#
The language that the plugin’s messages were written in
public string $sourceLanguage = 'en-US'
$t9nCategory
public property
#
The translation category that this plugin’s translation messages should use. Defaults to the lowercased plugin handle.
public string, null $t9nCategory = null