Skip to content
This repository has been archived by the owner on Apr 21, 2021. It is now read-only.

Latest commit

 

History

History
72 lines (39 loc) · 4.87 KB

plugins.md

File metadata and controls

72 lines (39 loc) · 4.87 KB

Plugins

::: tip If you’re looking for plugin development documentation, check out the Extending Craft section. :::

Plugins extend Craft’s core functionality. They can introduce new Dashboard widgets, field types, control panel sections, Twig templating features, workflow actions, and more.

The Plugin Store

Craft’s control panel features a Plugin Store, where you can browse through hundreds of free and commercial plugins, install them with a single click, and pay for them.

To access the Plugin Store, click on the “Plugin Store” item in Craft’s control panel navigation. From there you can browse through the various plugin categories and curated lists to discover new plugins.

The Craft Plugin Store

When you click on a plugin, a modal window will open with details about the plugin, including a long description and screenshots.

A plugin’s modal window within the Plugin Store

Installing Free Plugins

Free plugins can be installed by clicking the “Install” button. You’ll then be taken to the plugin installer page, which will keep you updated with Craft’s status as it works through the installation.

Trialing Commercial Plugins

Commercial plugins can be installed as a trial by clicking the “Try” button, if Craft is running on a development domain. You’ll then be taken to the plugin installer page, which will keep you updated with Craft’s status as it works through the installation.

Buying Commercial Plugins

If you have tried a commercial plugin and are ready to buy it, return to the Plugin Store and click on the Cart icon in the header area. You should see your plugin listed in the “Active Trials” section of the Cart modal. Click the “Add to cart” button to add the plugin to your cart, and then proceed with checkout.

Once you’ve completed the checkout process, your plugin installation will automatically become licensed.

Managing Plugin Licenses

You can manage all of your plugin licenses from your Craft ID account, under Licenses → Plugins

If you don’t have a Craft ID account yet, you can create one by going to id.craftcms.com/register.

Any plugin licenses that were purchased with the same email address as your Craft ID account will automatically be added to your account.

If you have a plugin license that isn’t showing up, go to Licenses → Claim License. You can enter its license key manually, or if you know the email address that was used for purchase, you can enter it in the “Claim licenses by email address” section. After verifying that you own the email address, any unclaimed licenses associated with that email address will be added to your account.

Safeguarding Plugin License Keys

By default your plugin license key will be stored in the database and project.yaml. You may, however, move that license key to a custom PHP constant and set the key using the $VARIABLE_NAME syntax.

If you were to create a MY_PLUGIN_KEY environment variable, for example, you could then use $MY_PLUGIN_KEY in place of the key itself anywhere the plugin license key is required.

Transferring Plugin Licenses

To transfer a plugin license to someone else’s Craft ID account, log into your Craft ID account, and click on the license under Licenses → Plugins, and then click the “Release License” button to release it from your account. Then the other person will be able to claim the license for themselves from the Licenses → Claim License page of their Craft ID account.

Commercial Plugin Licensing

Commercial plugins in the Plugin Store must follow Craft’s licensing model:

  • They are free to try in development environments, but require payment to be used in production environments.
  • Commercial licenses are a one-time fee per Craft installation, which comes with access to updates for one year after purchase.
  • Additional updates can be available with an annual update fee.
  • Licenses can be returned for a full refund within 30 days of purchase, no questions asked.

Additionally, all plugins in the Plugin Store must use either the MIT License or the Craft License. (Generally, free plugins will use the MIT License, and commercial plugins will use the Craft license.)

Together, these rules make plugin licensing safe and predictable for customers, while also helping provide a sustainable business model for plugin vendors.

Commercial Plugin Support

We don’t impose any specific support requirements on plugin vendors. You will need to check with them to learn about their support policies, so you know what to expect.

If you feel that a plugin vendor isn’t providing a reasonable level of support for a commercial plugin license, please send and email to [email protected] about it.