{"id":23858992,"url":"https://github.com/coloredcow/wp-plugin-boilerplate","last_synced_at":"2025-09-17T21:09:28.930Z","repository":{"id":45544463,"uuid":"275085936","full_name":"ColoredCow/wp-plugin-boilerplate","owner":"ColoredCow","description":"Yet another boilerplate for WordPress plugin! Based on WooCommerce.","archived":false,"fork":false,"pushed_at":"2021-12-09T06:57:43.000Z","size":127,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-22T10:51:19.434Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ColoredCow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-26T06:07:17.000Z","updated_at":"2023-05-20T15:03:33.000Z","dependencies_parsed_at":"2022-08-27T13:23:50.611Z","dependency_job_id":null,"html_url":"https://github.com/ColoredCow/wp-plugin-boilerplate","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ColoredCow/wp-plugin-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColoredCow%2Fwp-plugin-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColoredCow%2Fwp-plugin-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColoredCow%2Fwp-plugin-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColoredCow%2Fwp-plugin-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ColoredCow","download_url":"https://codeload.github.com/ColoredCow/wp-plugin-boilerplate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColoredCow%2Fwp-plugin-boilerplate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275664990,"owners_count":25506157,"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","status":"online","status_checked_at":"2025-09-17T02:00:09.119Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-01-03T03:28:59.818Z","updated_at":"2025-09-17T21:09:28.521Z","avatar_url":"https://github.com/ColoredCow.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WP Plugin Boilerplate\n\nA boilerplate to create WordPress plugin with rapid assets compilation using Grunt.\n\n## Prerequisites\n\n1. NPM\n1. Grunt\n\n## Installation \u0026 getting started\n\n### Via `composer`\n\n1. In your plugin's (empty) root directory, create a `composer.json` file and paste the following contents in it.\n\n   ```json\n   {\n     \"require\": {\n       \"composer/installers\": \"1.9.0\",\n       \"abhishek-pokhriyal/wp-plugin-boilerplate\": \"^1.0\"\n     },\n     \"extra\": {\n       \"installer-paths\": {\n       \"./\" : [\"abhishek-pokhriyal/wp-plugin-boilerplate\"]\n       }\n     }\n   }\n   ```\n\n1. Run `compser install`. This will put the boilerplate code in the plugin's root directory (it will also overwrite the contents of `composer.json` file created in the previous step.)\n\n### Manually\n\n1. Clone the repository inside your `wp-content/plugins/` directory.\n   ```bash\n   git clone https://github.com/abhishek-pokhriyal/wp-plugin-boilerplate.git\n   ```\n\n1. Rename file and variable names according to your plugin name.\n\n   1. Find and replace the following names:\n\n      Sl No| Find                  | Replace\n      -----|-----------------------|----------------\n      1    |`WP Plugin Boilerplate`|`My Plugin Name`\n      2    |`wp-plugin-boilerplate`|`my-plugin-name`\n      3    |`wp_plugin_boilerplate`|`my_plugin_name`\n      4    |`WpPluginBoilerplate`  |`MyPluginName`\n      5    |`WPB_`                 |`MPN_`\n      6    |`WPB()`                |`MPN()`\n      7    |`wpb-`                 |`mpn-`\n\n   1. Rename files containing `wp-plugin-boilerplate` to `my-plugin-name`:\n\n      Sl No| Default file name               | Your custom file name\n      -----|---------------------------------|-------------------------\n      1    |`wp-plugin-boilerplate.php`      |`my-plugin-name.php`\n      2    |`class-wp-plugin-boilerplate.php`|`class-my-plugin-name.php`\n\n\n1. Follow [Build steps for assets](#build-steps-for-assets) if any assets development/changes are involved.\n1. If your plugin does not need Bootstrap, you can delete the `bootstrap` and `utilities` directory from the `assets/css` directory and remove all the import containing bootstrap from `style.scss` .\n1. Now, you're ready to get started for the development.\n\n## Build steps for assets\n\n1. `cd` into the plugin root directory\n1. Install node dependencies\n   ```bash\n   npm install\n   ```\n\n1. Generate the compiled and minified files, run\n   ```bash\n   grunt\n   ```\n\n1. Generate the compiled and minified files while development (as soon as you hit `CMD + S`), run\n   ```bash\n   grunt watch\n   ```\n\n## Plugin structure\n\n```\n+-- assets/\n|   +-- css/\n|       +-- bootstrap/\n|       +-- utilities/\n|   +-- js/\n|       +-- admin/\n|       +-- frontend/\n|\n+-- includes/\n|   +-- class-wp-plugin-boilerplate.php\n|\n+-- node_modules/\n+-- .eslintignore\n+-- .eslintrc.js\n+-- .gitignore\n+-- Gruntfile.js\n+-- license.txt\n+-- package-lock.json\n+-- package.json\n+-- README.md\n+-- wp-plugin-boilerplate.php\n```\n\n## License\nWordPress Plugin BoilerPlate is released under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoloredcow%2Fwp-plugin-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoloredcow%2Fwp-plugin-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoloredcow%2Fwp-plugin-boilerplate/lists"}