PhpDev.App
WPBP/WordPress-Plugin-Boilerplate-Powered

WPBP/WordPress-Plugin-Boilerplate-Powered

Stars: 681

Forks: 107

Pull Requests: 49

Issues: 189

Watchers: 26

Last Updated: 2023-08-29 16:30:18

#php #wordpress #wordpress-plugin-boilerplate #boilerplate #hacktoberfest

Wordpress Plugin Boilerplate but Powered with examples and a generator!

License: GNU General Public License v3.0

Languages: JavaScript, PHP, Shell, SCSS

https://wpbp.github.io/

WordPress Plugin Boilerplate Powered

Logo

Backers on Open Collective Sponsors on Open Collective GitHub CI Workflow

Website | Wiki | GitHub | Code 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 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) will generate everything without the need of manual copy & paste way or searching on the Internet!

Features

  • Code Generator to start development
  • Sass support and WebPack (not mandatory because the generator can remove them)
  • PSR-4 support by Composer but extended to load classes based on request type and folder structure
  • GitHub Action and GitLab CI 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.

⚠ī¸ 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.
    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.
  7. npm install - Install node packages.
  8. npm run plugin-zip - Zip plugin files.

ℹī¸ npm pack --dry-run - You can verify files to zip by running this command.

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

Snippets

📝 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
  • WP-CLI support
  • Support for CMB2 in the options page

Other Tools

WPBP/tools
Bash scripts. Currently, has some for wp-bump-version and wp-readme-last-wp-tested.

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!

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

[Become a sponsor]

License

WordPress Plugin Boilerplate Powered is licensed under the GPL v3 or later; however, if you opt-in to use third-party code that is not compatible with v3, then you may need to switch to using code that is GPL v3 compatible.

OPEN ISSUES

See all

RELEASES

See all