Skip to content

Commit

Permalink
New README.md (#235)
Browse files Browse the repository at this point in the history 
Co-authored-by: Erik Golinelli <erik@codekraft.it>
Co-authored-by: Daniele Scasciafratte <mte90net@gmail.com>
  • Loading branch information
@Ryvix @erikyo @Mte90
3 people committed May 9, 2023
1 parent 1662485 commit e04ceb1
Showing 1 changed file with 96 additions and 35 deletions.
131 changes: 96 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,58 +6,116 @@

[![Backers on Open Collective](https://opencollective.com/WordPress-Plugin-Boilerplate-Powered/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/WordPress-Plugin-Boilerplate-Powered/sponsors/badge.svg)](#sponsors)
[![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)
[![Workflow](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/actions/workflows/integrate.yml/badge.svg)](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/actions)

**WordPress Plugin Boilerplate Powered** is a complete foundation for building your WordPress plugins following PSR-4 standard.
The project history is part of the [Wiki](https://wpbp.github.io/wiki.html) that also includes the workflow and how it is organized.
[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)

**WordPress Plugin Boilerplate Powered** is a complete foundation for building your WordPress plugins following PSR-4 standard.
The project history is part of the [Wiki](https://wpbp.github.io/wiki.html) that also includes the workflow and how it is organized.
Every experienced WordPress developer uses always the same libraries (or snippets) but at the same time follows best practices.
Choose 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&paste way or searching on the Internet!
Choose 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 & paste way or searching on the Internet!

## Features

### Available Libraries and other stuff

* [Code Generator](https://github.com/WPBP/generator) to start development
* Sass support and WebPack (not mandatory because the generator can remove them)
* 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
* Tools integrated like [GrumpPHP](https://github.com/phpro/grumphp) (automatically on commit)
and [PHPStan](https://github.com/phpstan/phpstan/)
* 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
* Tools integrated like [GrumpPHP](https://github.com/phpro/grumphp) (automatically on commit) and [PHPStan](https://github.com/phpstan/phpstan/)
* [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
* Many libraries already available (with starter code)

## Generator

The 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.
You should be able to run the commands and edit the files mentioned below to get started.
Read all these links and edit the code however you like using the libraries, snippets, and tools listed below.

> :warning: These steps may be incomplete and need expanded upon and testing. For example, you may also want to run
> tests, Codeception, etc.
1. `wpbp-generator --json` - Generate a new wpbp.json file in the current folder.
2. Edit the wpbp.json to your liking by removing what you don't want.
3. `wpbp-generator` - Download WPBP and extract it to a new folder and removes the parts you don't want.
Your new plugin folder is created as a subfolder in the current working directory.
4. `cd your-plugin-folder` - Change into your plugin folder:
5. Edit composer.json and change versions or packages to your liking.
6.
1. `composer install` - Install fresh with dev files.
When moving to production you should run ii and iii instead:
2. `composer --no-dev update` - Update composer with no dev files.
3. `composer dumpautoload -o` - Optimize composer
classes. [More info](https://getcomposer.org/doc/articles/autoloader-optimization.md).
7. `npm install` - Install node packages.
8. `npm run plugin-zip` - Zip plugin files.

> :information_source: `npm pack --dry-run` - You can verify files to zip by running this command.
> :memo: **Remember: Don't edit the vendor or node-modules folders. They are overwritten on updates.**
## Libraries

These are options in wpbp.json.
| WPBP Libraries | Other libraries |
| --------------- | --------------- |
| [WPBP/PointerPlus](https://github.com/WPBP/PointerPlus) | [CMB2/CMB2](https://github.com/CMB2/CMB2) |
| [WPBP/CronPlus](https://github.com/WPBP/CronPlus) | [micropackage/requirements](https://github.com/micropackage/requirements) |
| [WPBP/Widgets-Helper](https://github.com/WPBP/Widgets-Helper) | [inpsyde/assets](https://github.com/inpsyde/assets) |
| [WPBP/Page-Madness-Detector](https://github.com/WPBP/Page-Madness-Detector) | [origgami/CMB2-grid](https://github.com/origgami/cmb2-grid) |
| [WPBP/Template](https://github.com/WPBP/Template) | [johnbillion/extended-cpts](https://github.com/johnbillion/extended-cpts/) |
| [WPBP/Debug](https://github.com/WPBP/Debug) | [Freemius/wordpress-sdk](https://github.com/Freemius/wordpress-sdk) |
| [WPBP/CPT_Columns](https://github.com/WPBP/CPT_Columns) | [wpdesk/wp-notice](https://gitlab.com/wpdesk/wp-notice/-/tree/master) |
| [WPBP/i18n-notice](https://github.com/WPBP/i18n-notice) | [julien731/WP-Review-Me](https://github.com/julien731/WP-Review-Me) |
| | [stevegrunwell/wp-cache-remember](https://github.com/stevegrunwell/wp-cache-remember) |
| | [Seravo/wp-custom-bulk-actions](https://github.com/Seravo/wp-custom-bulk-actions) |
| | [yahnis-elsts/plugin-update-checker](https://github.com/YahnisElsts/plugin-update-checker/) |
| | [AyeCode/wp-super-duper](https://github.com/AyeCode/wp-super-duper) |
| | [decodelabs/tagged](https://github.com/decodelabs/tagged) |

### Available Snippets
| [WPBP/PointerPlus](https://github.com/WPBP/PointerPlus)<br>Create a WP Admin wizard-like system.| [CMB2/CMB2](https://github.com/CMB2/CMB2)<br>CMB2 is a developer's toolkit for building metaboxes, custom fields, and forms.|
| [WPBP/CronPlus](https://github.com/WPBP/CronPlus)<br>Add and remove cronjobs.| [micropackage/requirements](https://github.com/micropackage/requirements)<br>A requirements checker.|
| [WPBP/Widgets-Helper](https://github.com/WPBP/Widgets-Helper)<br>A class to ease creating powered Widgets.| [inpsyde/assets](https://github.com/inpsyde/assets)<br>A Composer package to deal with scripts and styles.|
| [WPBP/Page-Madness-Detector](https://github.com/WPBP/Page-Madness-Detector)<br>Detect if the website is using a pagebuilder/visual builder.| [origgami/CMB2-grid](https://github.com/origgami/cmb2-grid)<br>CMB2 grid columns.|
| [WPBP/Template](https://github.com/WPBP/Template)<br>Load template files with autosearch and multilanguage folder for email template.| [johnbillion/extended-cpts](https://github.com/johnbillion/extended-cpts/)<br>A library which provides extended functionality to WordPress custom post types and taxonomies.|
| [WPBP/Debug](https://github.com/WPBP/Debug)<br>Query Monitor Wrapper.| [Freemius/wordpress-sdk](https://github.com/Freemius/wordpress-sdk)<br>Freemius truly empowers developers to create prosperous subscription-based businesses.|
| [WPBP/CPT_Columns](https://github.com/WPBP/CPT_Columns)<br>Improve the CPT list in the backend.| [wpdesk/wp-notice](https://gitlab.com/wpdesk/wp-notice/)<br>Library to display notices in wp-admin.|
| [WPBP/i18n-notice](https://github.com/WPBP/i18n-notice)<br>Handle i18n for plugins, based on Yoast i18n-module.| [julien731/WP-Review-Me](https://github.com/julien731/WP-Review-Me)<br>A lightweight library to include in your WordPress theme/plugin to ask the user to review it on WordPress.org|
| | [stevegrunwell/wp-cache-remember](https://github.com/stevegrunwell/wp-cache-remember)<br>Helper for the object cache and transients.|
| | [Seravo/wp-custom-bulk-actions](https://github.com/Seravo/wp-custom-bulk-actions)<br>Custom bulk actions for any type of post.|
| | [yahnis-elsts/plugin-update-checker](https://github.com/YahnisElsts/plugin-update-checker/)<br>A custom update checker that supports GitHub,GItlab and others.|
| | [AyeCode/wp-super-duper](https://github.com/AyeCode/wp-super-duper)<br>A class to build a widget, shortcode and Gutenberg block.|
| | [decodelabs/tagged](https://github.com/decodelabs/tagged)<br>PHP markup generation in... PHP.|

## Snippets

> :memo: Specific code snippets already integrated that is possible to remove with the generator
### Backend

* bubble-notification-pending-cpt - Bubble notification on pending CPTs
* donate-link-plugin-list - Add the donate link in the plugin description inside the WP backend
* block support
* impexp-settings - Import/Export settings

### Frontend

* body-class - Class in frontend body with the slug of plugin
* cpt-search-support - Support on frontend to auto add the post type of the plugin to the global search
* wp-localize-script - `wp_localize_script` for passing PHP variables to JavaScript on the frontend
* shortcode - Shortcode example included
* template-system

### System

* capability-system - Custom capabilities with CPTs and taxonomy support
* upgrade-procedure - Basic procedure executed on plugin update
* transient - Transient examples with caching
* rest support

### More...

* Dashicons as dependency of admin stylesheet
* Bubble notification on pending CPTs
* Import/Export settings
* Custom capabilities with CPTs and taxonomy support
* `wp_localize_script` for passing PHP variables to JavaScript on the frontend
* Class in frontend body with the slug of plugin
* Shortcode example included
* WP-CLI support
* Support for CMB2 in the options page
* Transient examples with caching

## Other Tools

[WPBP/tools](https://github.com/WPBP/tools)
Bash scripts. Currently, has some for wp-bump-version and wp-readme-last-wp-tested.

[CodeAtCode/freemius-suite](https://github.com/CodeAtCode/freemius-suite)
Suite to package and deploy the free version of the plugin by Freemius on WordPress SVN.

## Made With WPBP

Do you want to see which plugins have been made with this boilerplate?
Check out [this Wiki page](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/wiki/Plugins-made-with-this-Boilerplate)!
Check out [this Wiki page](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered/wiki/Plugins-made-with-this-Boilerplate)!

## Contributors

Expand All @@ -66,11 +124,14 @@ This project exists thanks to all the people who contribute.

## Backers

Thank you to all our backers! 🙏
[[Become a backer](https://opencollective.com/WordPress-Plugin-Boilerplate-Powered#backer)]
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/WordPress-Plugin-Boilerplate-Powered#backer)]
<br>
<a href="https://opencollective.com/WordPress-Plugin-Boilerplate-Powered#backers" target="_blank"><img src="https://opencollective.com/WordPress-Plugin-Boilerplate-Powered/backers.svg?width=890"></a>

## Sponsors

[[Become a sponsor](https://opencollective.com/wordpress-plugin-boilerplate-powered/contribute/sponsors-1214/checkout)]

## License

WordPress Plugin Boilerplate Powered is licensed under the GPL v3 or later;
Expand Down

0 comments on commit e04ceb1

Please sign in to comment.