WordPress plugin boilerplate using React and Block Editor components.

Overview

PluginWP Foundation

🚧 UNDER DEVELOPMENT 🚧

This code serves as a starting point for building a WordPress plugin using React and the block editor components. I also wanted to build WordPress plugins in a more modern PHP way by introducing a portion of the Service Container and Service Providers that are used in the Laravel framework.

Installation

Requirements

Quick Start

Clone this repository or click Use this template on to create a new project on GitHub.

git clone https://github.com/jrtashjian/pluginwp.git yourpluginslug

Search for PluginWP Author and replace with Actual Author Name

find . -type f -not -path "./.git/*" -exec sed -i 's/PluginWP Author/Actual Author Name/g' {} +

Search for PluginWP and replace with YourPluginSlug

find . -type f -not -path "./.git/*" -exec sed -i 's/PluginWP/YourPluginSlug/g' {} +

Search for pluginwp and replace with yourpluginslug

find . -type f -not -path "./.git/*" -exec sed -i 's/pluginwp/yourpluginslug/g' {} +

Finally, rename the main plugin file pluginwp.php to yourpluginslug.php.

Setup

Install the necessary Node.js and Composer dependencies:

$ composer install
$ npm install

Available CLI commands

  • composer lint : checks all PHP files for syntax errors.
  • composer format : fixes all automatically fixable syntax errors.
  • npm run wp-env : exposes all commands available in @wordpress/env
  • npm run build : compiles all scripts and styles for distribution.
  • npm run dev : compiles all scripts and styles for development.

Now go build something!

You might also like...
The easiest way to develop and release Gutenberg blocks (components) for WordPress

Contents Install Comparison with competition Future Plans Usage Creating a Block Install npm install gutenblock -g This is a Gutenberg plugin creator

Centralized dashboard to monitor various WordPress components, stats and data, including the server.
Centralized dashboard to monitor various WordPress components, stats and data, including the server.

Centralized dashboard to monitor various WordPress components, stats and data, including the server.

Tema boilerplate WordPress

WordPress boilerplate based on _s Hi. I'm a starter theme called _s, or underscores, if you like. I'm a theme meant for hacking so don't use me as a P

A WordPress plugin to suspend WordPress sites automagically. Simple and lightweight, no annoying ads and fancy settings.
A WordPress plugin to suspend WordPress sites automagically. Simple and lightweight, no annoying ads and fancy settings.

Suspend WP A WordPress plugin to suspend WordPress sites automagically. Simple and lightweight, no annoying ads and fancy settings. 😎 Demo (coming so

Simple WordPress plugin to learn how to understand WordPress Crons and the Action Scheduler library.

Simple WordPress plugin to learn how to understand WordPress Crons and the Action Scheduler library. Import Jamendo playlists with tracks in WordPress posts.

A custom WordPress nav walker class to fully implement the Twitter Bootstrap 4.0+ navigation style (v3-branch available for Bootstrap 3) in a custom theme using the WordPress built in menu manager.

WP Bootstrap Navwalker This code in the main repo branch is undergoing a big shakeup to bring it in line with recent standards and to merge and test t

Easy handle APlayer on WordPress. A shortcode for WordPress to using APlayer.

Description Easy handle APlayer on WordPress. A shortcode for WordPress to using APlayer. Support [audio] tag, compatible with AMP. Requirement WordPr

The Pronamic WordPress Basecone plugin allows you to connect your WordPress installation to Basecone.

Pronamic WordPress Basecone The Pronamic WordPress Basecone plugin allows you to connect your WordPress installation to Basecone. Table of contents Au

WordPress plugin that lets you use Discourse as the community engine for a WordPress blog

WP Discourse Note: the wp-discourse plugin requires = PHP-5.4.0. The WP Discourse plugin acts as an interface between your WordPress site and your Di

Comments
  • Deploy plugin to the official WordPress Plugin Repository

    Deploy plugin to the official WordPress Plugin Repository

    Are boilerplate plugins even allowed in the official WordPress Plugins repository? If not, maybe I can just verify the deploy process works with another plugin already in the repo like curatewp-related-posts or curatewp-nested-posts.

    opened by jrtashjian 0
  • Write a tool for bootstrapping projects easier

    Write a tool for bootstrapping projects easier

    Currently setting your own project up is a manual process. Can a tool like Yeoman accomplish this or maybe WP-CLI since this is a WordPress specific project?

    opened by jrtashjian 2
  • Road to a stable release 🚀

    Road to a stable release 🚀

    This issue outlines the work needed to finish before tagging a stable release. This list may change based on suggestions or things I require in my own projects.

    Features

    • [x] #3
    • [ ] #2
    • [ ] Should be able to easily add or remove Jest, Playwright, and GitHub Actions configurations for alternatives.
    • [x] Example block-library package and service provider.

    Documentation

    • [ ] Bootstrap file and how it works
    • [ ] Service Container from Laravel 8.x (PHP 7.4 support)
    • [ ] Service Provider from Laravel 8.x (PHP 7.4 support)
    • [ ] Creating packages

    CI/CD Pipeline in GitHub Actions

    • [ ] Run phpunit against a PHP version and WordPress Multisite matrix
    • [ ] #5
    • [ ] #4
    • [ ] #6
    • [ ] #7
    opened by jrtashjian 0
Owner
JR Tashjian
Follower of Christ. Senior Software Engineer - WordPress Experience @GoDaddy. Continually seeking challenges and solving problems through code.
JR Tashjian
A plugin to disable the drop cap option in Gutenberg editor paragraph block. This is version 2.

Disable Drop Cap (v2) A plugin to disable drop cap option in the Gutenberg editor block editor paragraph block. Note for WordPress 5.8 With WordPress

Johannes Siipola 4 Jan 4, 2022
WordPress entities creation library (CPT, CT, native option page, ACF option page, user role, block pattern category, block category…)

WordPress entities creation library (CPT, CT, native option page, ACF option page, user role, block pattern category, block category…)

Loïc Antignac 2 Jul 25, 2022
🚀WordPress Plugin Boilerplate using modern web techs like TypeScript, SASS, and so on... on top of a local development environment with Docker and predefined GitLab CI for continous integration and deployment!

WP React Starter: WordPress React Boilerplate DEPRECATED: WP React Starter was a "research project" of devowl.io for the development of our WordPress

devowl.io GmbH 344 Jan 1, 2023
Documents WordPress Classic Editor integration points and their Gutenberg equivalents

Gutenberg Migration Guide This repository documents WordPress Classic Editor customization points and their Gutenberg equivalents (if such exist). Its

Daniel Bachhuber 185 Nov 16, 2022
WordPress plugin to make it easier to create block patterns.

=== Templets === Contributors: mkaz Tags: block patterns, patterns Requires at least: 5.8 Tested up to: 5.8 Requires PHP: 7.3 Stable tag: 0.2.0 Licens

Marcus Kazmierczak 9 Jan 3, 2023
This WordPress Plugin Boilerplate is meant for you to develop your own plugin on.

WordPress Plugin Boilerplate This plugin boilerplate is meant for you to develop your own plugin on. Support & collaboration Features OOP plugin core

richardev 2 May 10, 2022
Wordless is a junction between a WordPress plugin and a theme boilerplate that dramatically speeds up and enhances your custom theme creation

Wordless is a junction between a WordPress plugin and a theme boilerplate that dramatically speeds up and enhances your custom theme creation. Some of

weLaika 1.4k Dec 9, 2022
📦 A zero-configuration #0CJS developer toolkit for building WordPress Gutenberg block plugins.

create-guten-block is zero configuration dev-toolkit (#0CJS) to develop WordPress Gutenberg blocks in a matter of minutes without configuring React, w

Ahmad Awais ⚡️ 3.1k Dec 23, 2022
A simple little WordPress block that allows you add social share icons to your website.

Social Sharing Block This plugin requires WordPress 5.9+ or 5.8+ with Gutenberg active. A simple little block that allows you to add social share icon

Nick Diego 18 Dec 27, 2022
WordPress Plugin Boilerplate

This repository, developed by the team of Plugins & Snippets, offers an open source WordPress Plugin Template with many useful functions, specially to prepare basic widgets, short codes and settings page. The aim of this Boilerplate Template is to save time for WordPress Developers in building high-quality plugins.

null 3 Dec 15, 2022