How to set and update the title and description of a Craft CMS plugin

A walkthrough on setting the title and description of a Craft CMS plugin.

Oscar de la Hera Gomez
Written by Oscar de la Hera Gomez
First published on 01/15/2023 at 16:15
Last Updated on 02/14/2023 at 10:58
A flower that represents Craft CMS, beneath it sits the text "Plugin Description & Title."

A walkthrough on setting the title and description of a Craft CMS plugin.

The following tutorial walks you through how to change the title and description of a Craft CMS plugin.

Subscribe

We recommend that you download or clone our Open Source starter project, check out the tutorial/plugin branch and complete the steps below. The changes can be found on tutorial/plugin-description.

git clone git@github.com:delasign/craft-cms-starter.git
View RepositoryHow to create & setup a Craft CMS projectHow to create & setup a plugin in Craft CMS

Step One: Set or update your title and description

A screenshot of our Craft CMS plugin before updating the title and description.

The starter plugin without updating the title or description.

Navigate to your plugins composer.json.

A | Set the title

A screenshot of VSCode with a highlight on where you should update the title.

To change the title, change the string that follows name under extra on line 29.

We updated it to Sample Craft CMS Plugin.

B | Set the description

A screenshot of VSCode showing where you should update the description.

To change the title, change the string that follows description on line 3.

We updated it to Sample plugin description.

Step Two: Run Composer Update

A screenshot of Craft CMS with our plugin title and description updated.

The starter plugin after updating the title or description.

In terminal, set the current directory to the folder of your Craft CMS and run the following line:

composer update

Looking to change the icon of the plugin ? Follow the tutorial linked below.

How to add a custom icon to a Craft CMS plugin

Any questions ?

We are actively looking for feedback on how to improve this resource. Please send us a note to inquiries@delasign.com with any thoughts or feedback you may have.

SubscribeInquireView All PostsView All ServicesView All Work

Partner with us

We would love to get to know you and see how we can help your organization with its goals and needs.
Let's Talk

Stay Informed

Get occasional updates about our company, research, and product launches.
Subscribe