...
Note |
---|
Due to backwards compatibility with version 3.0, config.json files are not required but are strongly recommended as they may be required in future versions. |
Configuration Format
Example
Code Block | ||||
---|---|---|---|---|
| ||||
{ "version": "1.0.0", "name": "My Plugin Name", "description": "A plugin like no other!", "authors": [ { "name": "Phillips Data, Inc.", "url": "http://www.blesta.com" } ] } |
Definition
Option | Description | ||||||
---|---|---|---|---|---|---|---|
version | The version of the plugin. This should be a semantic version number. | ||||||
name | The name of the plugin. This may also be a language definition. | ||||||
description | A brief description of the plugin.
| ||||||
authors | An array of author objects.
| ||||||
logo | The path within the plugin to the logo file. If not set, defaults to views/default/images/logo.png. |
Using the Configuration
To use the configuration file you must include it within the constructor of your plugin using the loadConfig() method.
...