1.0.1 • Published 4 months ago

wcs-pb-generator v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
4 months ago

WCS Plugin Boilerplate Generator

This package helps you create a WordPress plugin boilerplate easily. If you want to download the boilerplate directly, go here.

Set Up

In your terminal, navigate to your WordPress installation's /wp-content/plugins/ folder.

To run the generator, run:

  npx wcs-pb-generator make-plugin <plugin-folder-name>

Here is the values it will ask you for replacement:

TypeTypeDescription
Plugin NameWCS Plugin BoilerplateReplace with your plugin's name
Plugin Slugwcs-plugin-boilerplateReplace with your plugin's slug
Plugin NamespacePlugin_NamespaceReplace with your main plugin's namespace
Plugin VersionWCSPB_VERSIONReplace with your plugin's version constant
Plugin PathWCSPB_PATHReplace with your plugin's path constant
Plugin Author NamePlugin AuthorReplace with your plugin author's name
Plugin Author EmailauthorEmailReplace with your plugin author's email

Composer Set Up

Once all the placeholders have been properly set, go into composer.json and change the name to match your project's VenderName\PluginName. Usually you will only have to change the vendor name as the plugin name will be set to your plugin slug.

Next, edit the content in the authors section to match your information.

Once everything is set, run composer install to create the vendor folder with the autoloader files.

Authors