Allow plugins to define descriptions of themselves

[angrybrad]

Created by: Jason McCallister (themccallister@gmail.com) on 2015/03/20 17:34:31 +0000 Votes at time of UserVoice import: 7

---

This idea was discussed in the Craft Slack channel for #craft3.

The basic concept is to allow developers to define a short description of their plugin in the plugins config.json.

This would allow quick a quick description of each plugin on the Craft control panel. It was pointed out that this maybe better handled by the Craft Plugin Store. However, it was also suggested that not all plugins will be installed through the Plugin Store.

Pros:

• One place to modify the plugins description for the control panel, and store
• Would be incredibly helpful in troubleshooting Craft installations/plugins from other developers/agencies

Cons:

• UI would require slight changes as to how the behavior is currently handled on the plugins control panel page
• Would require a plugin update from the developer to change the plugins description - but would have to be done for a regular update.

[angrybrad]

As of Craft 2.5, plugins can set a getDescription() method that returns a description of themselves, which will be displayed on the plugin index page (Settings → Plugins).