{"id":21813074,"url":"https://github.com/webdevstudios/generator-plugin-wp","last_synced_at":"2025-04-05T10:09:24.336Z","repository":{"id":28060218,"uuid":"31556879","full_name":"WebDevStudios/generator-plugin-wp","owner":"WebDevStudios","description":"Yeoman WordPress Plugin Generator","archived":false,"fork":false,"pushed_at":"2020-09-05T13:29:26.000Z","size":543,"stargazers_count":291,"open_issues_count":10,"forks_count":64,"subscribers_count":46,"default_branch":"master","last_synced_at":"2025-03-29T09:11:38.347Z","etag":null,"topics":["generator","wordpress","wordpress-plugin","yeoman"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WebDevStudios.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-02T18:53:11.000Z","updated_at":"2025-03-14T03:57:37.000Z","dependencies_parsed_at":"2022-07-10T18:31:07.649Z","dependency_job_id":null,"html_url":"https://github.com/WebDevStudios/generator-plugin-wp","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebDevStudios%2Fgenerator-plugin-wp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebDevStudios%2Fgenerator-plugin-wp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebDevStudios%2Fgenerator-plugin-wp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebDevStudios%2Fgenerator-plugin-wp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WebDevStudios","download_url":"https://codeload.github.com/WebDevStudios/generator-plugin-wp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247318745,"owners_count":20919484,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generator","wordpress","wordpress-plugin","yeoman"],"created_at":"2024-11-27T14:27:04.639Z","updated_at":"2025-04-05T10:09:24.311Z","avatar_url":"https://github.com/WebDevStudios.png","language":"JavaScript","readme":"# generator-plugin-wp [![buddy pipeline](https://app.buddy.works/webdevstudios/generator-plugin-wp/pipelines/pipeline/226897/badge.svg?token=2471ae60766a1e9a657f772e493188dde748aa18c236d0b1c325e80be13a2ac6 \"buddy pipeline\")](https://app.buddy.works/webdevstudios/generator-plugin-wp/pipelines/pipeline/226897)\n\n\n\u003e [Yeoman](http://yeoman.io) generator for WordPress plugins.\n\n\u003ca href=\"https://webdevstudios.com/contact/\"\u003e\u003cimg src=\"https://webdevstudios.com/wp-content/uploads/2018/04/wds-github-banner.png\" alt=\"WebDevStudios. WordPress for big brands.\"\u003e\u003c/a\u003e\n\n## Getting Started\n\nPre-requisites: You'll need [node](https://nodejs.org/download/) which comes\nwith [npm](https://github.com/npm/npm#super-easy-install).\n\nIf you don't have [Yeoman](http://yeoman.io/) installed:\n\n```bash\nnpm install -g yo\n```\n\nTo install generator-plugin-wp from npm, run:\n\n```bash\nnpm install -g generator-plugin-wp\n```\n\nTo use generator-plugin-wp, `cd` to your WordPress plugins folder and:\n\n```bash\nyo plugin-wp\n```\nYou'll be prompted with steps for creating your plugin.\n\n## Sub-generators\n\nOnce your nifty new plugin has been generated, `cd` into your new plugin's\ndirectory. While in the plugin directory, you can run additional commands\ncalled sub-generators to automatically generate files to enhance your plugin.\n\n* `yo plugin-wp:include \u003cinclude-name\u003e` [Basic Include](include/README.md)\n* `yo plugin-wp:cpt \u003ccpt-name\u003e` [Custom Post Type](cpt/README.md)\n* `yo plugin-wp:cli \u003ccli-command-name\u003e` [WP CLI Command](cli/README.md)\n* `yo plugin-wp:taxonomy \u003ctaxonomy-name\u003e` [Taxonomy](taxonomy/README.md)\n* `yo plugin-wp:options \u003coptions-name\u003e` [Option Page](options/README.md)\n* `yo plugin-wp:widget \u003cwidget-name\u003e` [Widget](widget/README.md)\n* `yo plugin-wp:endpoint \u003cclass-name\u003e` [WP-API Endpoint](endpoint/README.md)\n* `yo plugin-wp:js` [Javascript](js/README.md)\n* `yo plugin-wp:css` [Styles](css/README.md)\n\nFor the names of the include, cpt, options, and widget subgenerators remember\nthat the plugin prefix will be added to the class name so no need to include the\noriginal plugin name there. Think of it as the file name for each instead.\n\n## Tests\n\nBy default the plugin generator adds some built in tests for you to add on to as\nyou develop your plugin. To run these tests run the `install-wp-tests.sh` script\nin the bin folder with the proper database details for your local setup.\n\nOnce you've run the `install-wp-tests.sh` script you can run just `phpunit` in\nthe main folder of your plugin.\n\nIf you don't want tests included in your plugin when it is generated run the\nmain generator with the `--notests` option.\n\n## PHP 5.2\n\nBy default PHP 5.2 is not supported in the generated plugin. To generate a plugin\nwith PHP 5.2 support, run the main generator with the `--php52` option.\n\n## CMB2\nCMB2 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.\n\n## Adding Packages with Composer\n\nIf you chose composer as the autoloader option during the plugin's initiation,\nyou can use composer to add additional dependencies.\n\nLet's `cd` into our new plugin's directory and add [CMB2](https://github.com/CMB2/CMB2):\n\n```bash\ncomposer require cmb2/cmb2\n```\n\nCMB2 will now appear under `vendor`\n\n```bash\n-plugins\n  -wds-foo-plugin\n    -vendor\n      -cmb2\n        -cmb2\n```\n\n## Contributors\nThe following humans contributed to this awesome generator:\n\n![](https://avatars1.githubusercontent.com/u/804253?v=3\u0026s=20) [CamdenSegal](https://github.com/CamdenSegal), ![](https://avatars0.githubusercontent.com/u/1098900?v=3\u0026s=20) [jtsternberg](https://github.com/jtsternberg), ![](https://avatars2.githubusercontent.com/u/991511?v=3\u0026s=20) [jazzsequence](https://github.com/jazzsequence), ![](https://avatars1.githubusercontent.com/u/16279215?v=3\u0026s=20) [binarygary](https://github.com/binarygary), ![](https://avatars1.githubusercontent.com/u/66798?v=3\u0026s=20) [bradp](https://github.com/bradp), ![](https://avatars3.githubusercontent.com/u/720377?v=3\u0026s=20) [JeffreyNaval](https://github.com/JeffreyNaval), ![](https://avatars1.githubusercontent.com/u/200280?v=3\u0026s=20) [gregrickaby](https://github.com/gregrickaby), ![](https://avatars0.githubusercontent.com/u/1777519?v=3\u0026s=20) [DevNIX](https://github.com/DevNIX), ![](https://avatars2.githubusercontent.com/u/871924?v=3\u0026s=20) [JPry](https://github.com/JPry), ![](https://avatars2.githubusercontent.com/u/2522431?v=3\u0026s=20) [RC Lations](https://github.com/rclations), ![](https://avatars2.githubusercontent.com/u/796639?v=3\u0026s=20) [tnorthcutt](https://github.com/tnorthcutt), ![](https://avatars2.githubusercontent.com/u/1753298?v=3\u0026s=20) [aubreypwd](https://github.com/aubreypwd), ![](https://avatars2.githubusercontent.com/u/6805601?v=3\u0026s=20) [JeffMatson](https://github.com/JeffMatson)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdevstudios%2Fgenerator-plugin-wp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebdevstudios%2Fgenerator-plugin-wp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdevstudios%2Fgenerator-plugin-wp/lists"}