Welcome to the WP Plugin Starter repository on GitHub. Here you can browse the source, look at open issues and use this template to bootstrap your next WordPress plugin development.
WP Plugin Starter requires the following dependencies:
Click "Use this template" at the top of this page, or click here to create your repo and clone locally to your wp-content/plugins directory. After that you'll need to do a four-step find and replace on the name in all the templates.
- Search for
WP Plugin Starterto capture the plugin name and replace with:Plugin Name. - Search for
WP_Plugin_Starterto capture the plugin namespace and replace with:Plugin_Name. - Search for
wp-plugin-starterto capture the plugin slug, textdomain, etc. and replace with:plugin-name. - Search for
WPS_(in uppercase) to capture constants and replace with:PLUGIN_NAME_.
Then, rename the plugin main file wp-plugin-starter.php to use the plugin's slug. Next, update or delete this readme.
To start using all the tools that come with WP Plugin Starter you need to install the necessary Node.js and Composer dependencies:
$ composer install
$ npm installWithout performing this step, if you try to activate the plugin it will simply show an admin notice.
WP Plugin Starter comes packed with CLI commands tailored for WordPress plugin development:
npm run build- builds the code for production.npm run start- starts the build for development.npm run format- formats files in the entire project’s directories.npm run lint:js– lints JavaScript files in the entire project’s directories.npm run lint:css– lints CSS and SCSS files in the entire project’s directories.npm run lint:php– lints PHP files in the entire project’s directories.composer makepot: Generates a .pot file in thelanguages/directory.composer makepot-audit: Generates a .pot file in thelanguages/directory and run audit.
Now you're ready to go! The next step is easy to say, but harder to do: make an awesome WordPress plugin. :)
Good luck!