Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WebDevStudios/generator-plugin-wp
Yeoman WordPress Plugin Generator
https://github.com/WebDevStudios/generator-plugin-wp
generator wordpress wordpress-plugin yeoman
Last synced: 3 months ago
JSON representation
Yeoman WordPress Plugin Generator
- Host: GitHub
- URL: https://github.com/WebDevStudios/generator-plugin-wp
- Owner: WebDevStudios
- License: gpl-3.0
- Created: 2015-03-02T18:53:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-05T13:29:26.000Z (about 4 years ago)
- Last Synced: 2024-08-01T17:56:32.000Z (3 months ago)
- Topics: generator, wordpress, wordpress-plugin, yeoman
- Language: JavaScript
- Homepage:
- Size: 530 KB
- Stars: 289
- Watchers: 47
- Forks: 64
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-wp-developer-tools - Yeoman WordPress Plugin Generator - Yeoman generator for WordPress plugins. (WordPress Plugins)
README
# generator-plugin-wp [](https://app.buddy.works/webdevstudios/generator-plugin-wp/pipelines/pipeline/226897)
> [Yeoman](http://yeoman.io) generator for WordPress plugins.
## Getting Started
Pre-requisites: You'll need [node](https://nodejs.org/download/) which comes
with [npm](https://github.com/npm/npm#super-easy-install).
If you don't have [Yeoman](http://yeoman.io/) installed:
```bash
npm install -g yo
```
To install generator-plugin-wp from npm, run:
```bash
npm install -g generator-plugin-wp
```
To use generator-plugin-wp, `cd` to your WordPress plugins folder and:
```bash
yo plugin-wp
```
You'll be prompted with steps for creating your plugin.
## Sub-generators
Once your nifty new plugin has been generated, `cd` into your new plugin's
directory. While in the plugin directory, you can run additional commands
called sub-generators to automatically generate files to enhance your plugin.
* `yo plugin-wp:include ` [Basic Include](include/README.md)
* `yo plugin-wp:cpt ` [Custom Post Type](cpt/README.md)
* `yo plugin-wp:cli ` [WP CLI Command](cli/README.md)
* `yo plugin-wp:taxonomy ` [Taxonomy](taxonomy/README.md)
* `yo plugin-wp:options ` [Option Page](options/README.md)
* `yo plugin-wp:widget ` [Widget](widget/README.md)
* `yo plugin-wp:endpoint ` [WP-API Endpoint](endpoint/README.md)
* `yo plugin-wp:js` [Javascript](js/README.md)
* `yo plugin-wp:css` [Styles](css/README.md)
For the names of the include, cpt, options, and widget subgenerators remember
that the plugin prefix will be added to the class name so no need to include the
original plugin name there. Think of it as the file name for each instead.
## Tests
By default the plugin generator adds some built in tests for you to add on to as
you develop your plugin. To run these tests run the `install-wp-tests.sh` script
in the bin folder with the proper database details for your local setup.
Once you've run the `install-wp-tests.sh` script you can run just `phpunit` in
the main folder of your plugin.
If you don't want tests included in your plugin when it is generated run the
main generator with the `--notests` option.
## PHP 5.2
By default PHP 5.2 is not supported in the generated plugin. To generate a plugin
with PHP 5.2 support, run the main generator with the `--php52` option.
## CMB2
CMB2 is included by default with the options sub-generator. It can also be a useful tool with CPT and taxonomy sub-generators using the --cmb2 flag.
## Adding Packages with Composer
If you chose composer as the autoloader option during the plugin's initiation,
you can use composer to add additional dependencies.
Let's `cd` into our new plugin's directory and add [CMB2](https://github.com/CMB2/CMB2):
```bash
composer require cmb2/cmb2
```
CMB2 will now appear under `vendor`
```bash
-plugins
-wds-foo-plugin
-vendor
-cmb2
-cmb2
```
## Contributors
The following humans contributed to this awesome generator:
 [CamdenSegal](https://github.com/CamdenSegal),  [jtsternberg](https://github.com/jtsternberg),  [jazzsequence](https://github.com/jazzsequence),  [binarygary](https://github.com/binarygary),  [bradp](https://github.com/bradp),  [JeffreyNaval](https://github.com/JeffreyNaval),  [gregrickaby](https://github.com/gregrickaby),  [DevNIX](https://github.com/DevNIX),  [JPry](https://github.com/JPry),  [RC Lations](https://github.com/rclations),  [tnorthcutt](https://github.com/tnorthcutt),  [aubreypwd](https://github.com/aubreypwd),  [JeffMatson](https://github.com/JeffMatson)