Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejavascript
title/plugins/my_plugin/config.json
{
    "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

OptionDescription
versionThe version of the plugin. This should be a semantic version number.
nameThe name of the plugin. This may also be a language definition.
description

A brief description of the plugin.

NotePlanned for future use

This may also be a language definition in Blesta v4.9.0+.

authors

An array of author objects.

OptionDescription
nameThe name of the author. This may be a language definition
urlThe URL to link to for the author.


logoThe 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.

...