{"id":14954928,"url":"https://github.com/wpbp/wordpress-plugin-boilerplate-powered","last_synced_at":"2025-04-09T05:06:52.011Z","repository":{"id":18153562,"uuid":"21248950","full_name":"WPBP/WordPress-Plugin-Boilerplate-Powered","owner":"WPBP","description":"Wordpress Plugin Boilerplate but Powered with examples and a generator!","archived":false,"fork":false,"pushed_at":"2024-07-23T09:22:10.000Z","size":2463,"stargazers_count":790,"open_issues_count":8,"forks_count":114,"subscribers_count":28,"default_branch":"master","last_synced_at":"2024-10-29T14:14:43.569Z","etag":null,"topics":["boilerplate","hacktoberfest","php","wordpress","wordpress-plugin-boilerplate"],"latest_commit_sha":null,"homepage":"https://wpbp.github.io/","language":"PHP","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/WPBP.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-06-26T17:29:18.000Z","updated_at":"2024-10-29T02:33:34.000Z","dependencies_parsed_at":"2024-04-17T10:53:27.006Z","dependency_job_id":"04743c3f-66fb-4462-a74f-da396b99334e","html_url":"https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered","commit_stats":{"total_commits":781,"total_committers":19,"mean_commits":41.10526315789474,"dds":"0.23303457106274006","last_synced_commit":"4d7025f999cff1f55a184bb9c6c917a1c7d046a6"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WPBP%2FWordPress-Plugin-Boilerplate-Powered","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WPBP%2FWordPress-Plugin-Boilerplate-Powered/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WPBP%2FWordPress-Plugin-Boilerplate-Powered/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WPBP%2FWordPress-Plugin-Boilerplate-Powered/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WPBP","download_url":"https://codeload.github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980836,"owners_count":21027808,"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":["boilerplate","hacktoberfest","php","wordpress","wordpress-plugin-boilerplate"],"created_at":"2024-09-24T13:10:15.158Z","updated_at":"2025-04-09T05:06:51.989Z","avatar_url":"https://github.com/WPBP.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WordPress Plugin Boilerplate Powered\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/WPBP/boilerplate-assets/master/icon-256x256.png\" alt=\"Logo\"\u003e\n\u003c/p\u003e\n\n[![GitHub CI](https://img.shields.io/github/actions/workflow/status/WPBP/WordPress-Plugin-Boilerplate-Powered/integrate.yml)](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/actions)\n[![Workflow](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/actions/workflows/integrate.yml/badge.svg)](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/actions)\n\n[Website](https://wpbp.github.io/index.html) | [Wiki](https://wpbp.github.io/wiki.html) | [GitHub](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered) | [Code Generator](https://github.com/WPBP/generator)\n\n**WordPress Plugin Boilerplate Powered** is a complete foundation for building your WordPress plugins following PSR-4 standard.  \nThe project history is part of the [Wiki](https://wpbp.github.io/wiki.html) that also includes the workflow and how it is organized.  \nEvery experienced WordPress developer uses always the same libraries (or snippets) but at the same time follows best practices.  \nChoose a library or a snippet and the boilerplate (with the help of the [Code Generator](https://wpbp.github.io/#generator)) will generate everything without the need of manual copy \u0026 paste way or searching on the Internet!\n\n## Features\n\n* [Code Generator](https://github.com/WPBP/generator) to start development\n* Sass support and WebPack (not mandatory because the generator can remove them)\n* PSR-4 support by Composer  but [extended](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/blob/master/plugin-name/engine/class-initialize.php) to load classes based on request type and folder structure\n  * Tools integrated like [GrumpPHP](https://github.com/phpro/grumphp) (automatically on commit) and [PHPStan](https://github.com/phpstan/phpstan/)\n* [GitHub Action](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/blob/master/.github/workflows/integrate.yml) and [GitLab CI](https://gist.github.com/Mte90/abbb816e9755f189ad52272e71b7c959) available\n* Many libraries already available (with starter code)\n\n## Generator\n\nThe final usage ultimately depends on what you edit in the wpbp.json and composer.json files, and of course any other changes you've made.  \nYou should be able to run the commands and edit the files mentioned below to get started.  \nRead all these links and edit the code however you like using the libraries, snippets, and tools listed below.\n\n\u003e :warning: These steps may be incomplete and need expanded upon and testing. For example, you may also want to run\n\u003e tests, Codeception, etc.\n\n1. `wpbp-generator --json` - Generate a new wpbp.json file in the current folder.\n2. Edit the wpbp.json to your liking by removing what you don't want.\n3. `wpbp-generator` - Download WPBP and extract it to a new folder and removes the parts you don't want.   \n   Your new plugin folder is created as a subfolder in the current working directory.\n4. `cd your-plugin-folder` - Change into your plugin folder:\n5. Edit composer.json and change versions or packages to your liking.\n6.\n    1. `composer install` - Install fresh with dev files.  \n       When moving to production you should run ii and iii instead:\n    2. `composer --no-dev update` - Update composer with no dev files.\n    3. `composer dumpautoload -o` - Optimize composer\n     classes. [More info](https://getcomposer.org/doc/articles/autoloader-optimization.md).\n7. `npm install` - Install node packages.\n8. `npm run plugin-zip` - Zip plugin files.\n\n\u003e :information_source: `npm pack --dry-run` - You can verify files to zip by running this command.\n\n\u003e :memo: **Remember: Don't edit the vendor or node-modules folders. They are overwritten on updates.**\n\n## Libraries\n\nThese are options in wpbp.json.\n| WPBP Libraries  | Other libraries |\n| --------------- | --------------- |\n| [WPBP/PointerPlus](https://github.com/WPBP/PointerPlus)\u003cbr\u003eCreate a WP Admin wizard-like system.| [CMB2/CMB2](https://github.com/CMB2/CMB2)\u003cbr\u003eCMB2 is a developer's toolkit for building metaboxes, custom fields, and forms.|\n| [WPBP/CronPlus](https://github.com/WPBP/CronPlus)\u003cbr\u003eAdd and remove cronjobs.| [micropackage/requirements](https://github.com/micropackage/requirements)\u003cbr\u003eA requirements checker.|\n| [WPBP/Widgets-Helper](https://github.com/WPBP/Widgets-Helper)\u003cbr\u003eA class to ease creating powered Widgets.| [inpsyde/assets](https://github.com/inpsyde/assets)\u003cbr\u003eA Composer package to deal with scripts and styles.|\n| [WPBP/Page-Madness-Detector](https://github.com/WPBP/Page-Madness-Detector)\u003cbr\u003eDetect if the website is using a pagebuilder/visual builder.| [origgami/CMB2-grid](https://github.com/origgami/cmb2-grid)\u003cbr\u003eCMB2 grid columns.|\n| [WPBP/Template](https://github.com/WPBP/Template)\u003cbr\u003eLoad template files with autosearch and multilanguage folder for email template.| [johnbillion/extended-cpts](https://github.com/johnbillion/extended-cpts/)\u003cbr\u003eA library which provides extended functionality to WordPress custom post types and taxonomies.|\n| [WPBP/Debug](https://github.com/WPBP/Debug)\u003cbr\u003eQuery Monitor Wrapper.| [Freemius/wordpress-sdk](https://github.com/Freemius/wordpress-sdk)\u003cbr\u003eFreemius truly empowers developers to create prosperous subscription-based businesses.|\n| [WPBP/CPT_Columns](https://github.com/WPBP/CPT_Columns)\u003cbr\u003eImprove the CPT list in the backend.| [wpdesk/wp-notice](https://packagist.org/packages/wpdesk/wp-notice)\u003cbr\u003eLibrary to display notices in wp-admin.|\n| [WPBP/i18n-notice](https://github.com/WPBP/i18n-notice)\u003cbr\u003eHandle i18n for plugins, based on Yoast i18n-module.| [julien731/WP-Review-Me](https://github.com/julien731/WP-Review-Me)\u003cbr\u003eA lightweight library to include in your WordPress theme/plugin to ask the user to review it on WordPress.org|\n|                 | [stevegrunwell/wp-cache-remember](https://github.com/stevegrunwell/wp-cache-remember)\u003cbr\u003eHelper for the object cache and transients.|\n|                 | [Seravo/wp-custom-bulk-actions](https://github.com/Seravo/wp-custom-bulk-actions)\u003cbr\u003eCustom bulk actions for any type of post.|\n|                 | [yahnis-elsts/plugin-update-checker](https://github.com/YahnisElsts/plugin-update-checker/)\u003cbr\u003eA custom update checker that supports GitHub,GItlab and others.|\n|                 | [AyeCode/wp-super-duper](https://github.com/AyeCode/wp-super-duper)\u003cbr\u003eA class to build a widget, shortcode and Gutenberg block.|\n|                 | [decodelabs/tagged](https://github.com/decodelabs/tagged)\u003cbr\u003ePHP markup generation in... PHP.|\n\n## Snippets\n\n\u003e :memo: Specific code snippets already integrated that is possible to remove with the generator\n\n### Backend\n\n* bubble-notification-pending-cpt - Bubble notification on pending CPTs\n* donate-link-plugin-list - Add the donate link in the plugin description inside the WP backend\n* block support\n* impexp-settings - Import/Export settings\n\n### Frontend\n\n* body-class - Class in frontend body with the slug of plugin\n* cpt-search-support - Support on frontend to auto add the post type of the plugin to the global search\n* wp-localize-script - `wp_localize_script` for passing PHP variables to JavaScript on the frontend\n* shortcode - Shortcode example included\n* template-system\n\n### System\n\n* capability-system - Custom capabilities with CPTs and taxonomy support\n* upgrade-procedure - Basic procedure executed on plugin update\n* transient - Transient examples with caching\n* rest support\n\n### More...\n\n* Dashicons as dependency of admin stylesheet\n* WP-CLI support\n* Support for CMB2 in the options page\n\n## Other Tools\n\n[WPBP/tools](https://github.com/WPBP/tools)  \nBash scripts. Currently, has some for wp-bump-version and wp-readme-last-wp-tested.\n\n[CodeAtCode/freemius-suite](https://github.com/CodeAtCode/freemius-suite)  \nSuite to package and deploy the free version of the plugin by Freemius on WordPress SVN.\n\n## Made With WPBP\n\nDo you want to see which plugins have been made with this boilerplate?\nCheck out [this Wiki page](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/wiki/Plugins-made-with-this-Boilerplate)!\n\n## License\n\nWordPress Plugin Boilerplate Powered is licensed under the GPL v3 or later;\nhowever, if you opt-in to use third-party code that is not compatible with v3,\nthen you may need to switch to using code that is GPL v3 compatible.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwpbp%2Fwordpress-plugin-boilerplate-powered","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwpbp%2Fwordpress-plugin-boilerplate-powered","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwpbp%2Fwordpress-plugin-boilerplate-powered/lists"}