README.md

WordPress Plugin Boilerplate

Updated verision of WordPress Plugin Boilerplate. Includes a Webpack build script and webpack-dev-server for local development. Integrates PHP namespacing and PSR-4 autoloader for better experience.

Setup

Follow Setup instructions here

Issues

Please use Github issues to submit any bugs you may find.

Documentation

Plugin documentation with instalation instruction and best practices can be found at wiki page.

Features

• Sass for stylesheets
• Stylelint
• ES6 with Babel for JavaScript
• ESLint
• Webpack 5 build script for frontend and wp-admin assets
• Webpack dev server with live reloading and HMR
• PSR-4 Autoloader
• SVG Spritemap by cascornelissen

Requirements

Make sure all dependencies have been installed before moving on:

• WordPress >= 5.0
• PHP >= 8.1
• Composer
• Node.js >= 20
• Yarn

Coding Standards

• wpcs : analyze code against the WordPress coding standards with PHP_CodeSniffer.
• cbf : fix coding standards warnings/errors automatically with PHP Code Beautifier.
• lint : lint PHP files against parse errors.

To check a file against the WordPress coding standards or to automatically fix coding standards, simply specify the file's location:

• wpcs includes/class-init.php
• cbf includes/class-init.php

License

This project is licensed under the GPL license.