Scaffold plugin for creating and managing Blocks, Block Patterns, Block Styles and Block Editor Sidebars in the WordPress Block Editor (aka Gutenberg).

Rareview

Last update: Aug 2, 2022

Related tags

Overview

WordPress Block Editor Scaffold

This project is a template repo for developing WordPress Blocks, Block Patterns, Block Styles and Block Editor Sidebars in an automated and organized fashion.

Project Structure

As a WordPress Plugin, this project follows all requirements necessary for building a plugin; in addition, it uses different package management tools to enable developers to build faster and smarter, using modern web development features.

Composer for managing PHP Dependencies

Aside from the required plugin file, all PHP code is located within the lib directory, which are autoloaded as classes and hooked on plugins_loaded.

Each newly added class must extend the Config class located in the main plugin file, which provides both useful utility methods and ensuring Class registration only occurs once.

Node, NPM and Webpack for JavaScript Dependencies

Much like the WordPress Block Editor project (aka Gutenberg), this plugin uses Node, NPM and Webpack for managing JavaScript dependencies. In addition, automated build processes are included to ensure only those required dependencies are built, and all WordPress scripts are added as dependencies when enqueued.

Installation

This plugin can be installed as a standard WordPress plugin, but it is highly recommended to use as a Must Use WordPress Plugin to ensure Block Editor functionalty does not change by an accidental plugin deactivation.

Install as Must Use plugin

Installing as a Must Use plugin requires an additional step to load the required plugin file. First, add this plugin to the mu-plugins directory and add a file at the top-level of the mu-plugins directory named loader.php. Within loader.php`, simply require the plugin file like so:

require_once __DIR__ . '/wp-block-editor/block-editor.php`;

Please note that this is just an example and there are many ways to require plugins within the Must Use directory. If you already have a file that loads plugins in this directory, then simply requiring within that file will suffice.

More Information

Within other directories of this plugin there are README.md files describing in more detail the requirements for adding Blocks (block-library), Block Patterns (block-patterns), Block Styles (block-styles) and Block Editor Sidebars (sidebars). Please read each to better understand how these are added to the Block Editor.

Comments

JSON Schemas are coming to `block.json` near you!
Further reading:

WP.org > Block API Reference > Metadata

Automatic Tooltips & Validation for theme.json & block.json Files!

Redirects for JSON Schemas

enhancement
opened by colorful-tones 0
Pattern block and block pattern improvements for upcoming WP 5.9
https://github.com/WordPress/gutenberg/pull/33217

Output content containing strings that can be internationalized.

Output dynamic URLs see Include the flying bird image in the homepage header twentytwentytwo#92

Also, worth noting this: [Patterns]: Add a flag to hide patterns from UI #36108

Pattern block: remove wrapping div #36090

Lots of new Pattern API improvements coming along for WP 5.9! 🥳
enhancement
opened by colorful-tones 0
Remove/hide core's default patterns

Right now we have remove_theme_support( 'core-block-patterns' ); in WP Theme Scaffold, but it would be more suitable here.

Plus, with the way things are heading for WP 5.9 There is less of a need at all for the entirety of WP Theme Scaffold's lib/Theme_Setup.php file altogether.
enhancement

opened by colorful-tones 0
Try: consider adding style guide block patterns

In a recent project we ended up incorporating Figma style guides in to unique patterns, which I think was super helpful for establishing a baseline, as well as visual documentation for client and engineering. It might be good to incorporate an example in this repo? 🤔
enhancement question

opened by colorful-tones 0

Try: consider adding in example block pattern categories

In a recent project we ended up having a few common block pattern categories registered, which I think was super helpful (for client and engineering).

	// Block pattern categories.
	const BLOCK_PATTERN_CATEORIES = [
		'general'             => [ 'label' => 'General' ],
		'general-carousels'   => [ 'label' => 'Carousels' ],
		'general-heroes'      => [ 'label' => 'Heroes' ],
		'general-cta'         => [ 'label' => 'Calls-to-Action' ],
		'general-columns'     => [ 'label' => 'Columns' ],
		'general-pricing'     => [ 'label' => 'Pricing' ],
		'general-query-loops' => [ 'label' => 'Query Loops' ],
		'style-guides'         => [ 'label' => 'Style Guides' ],
	];

enhancement question

opened by colorful-tones 0

Owner

Rareview

Agencies are a dime a dozen. The great ones are rare.

GitHub https://rareview.com/careers

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

239 Nov 11, 2022

Examples for extending WordPress/Gutenberg with blocks.

Gutenberg Examples Examples for extending Gutenberg with plugins which create blocks. See also: Gutenberg developer documentation Installation Gutenbe

1.1k Dec 29, 2022

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

185 Nov 16, 2022

Query gutenberg blocks with wp-graphql

WPGraphQL Gutenberg Query gutenberg blocks through wp-graphql Usage Docs Join our community through WpGraphQL Slack Install Requires PHP 7.0+ Requires

270 Jan 3, 2023

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

9 Jan 3, 2023

📦 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

3.1k Dec 23, 2022

WordPress plugin for fluent management of scripts and styles.

Encute WordPress plugin for fluent management of scripts and styles. Managing scripts and styles on the front of your site can be tricky. This makes i

100 Nov 4, 2022

WordPress plugin boilerplate using React and Block Editor components.

PluginWP Foundation ?? UNDER DEVELOPMENT ?? This code serves as a starting point for building a WordPress plugin using React and the block editor comp

5 Dec 8, 2022

A simple scaffold used for what's needed to spin up a Composer-based WordPress plugin.

29 Dec 29, 2022

A WordPress plugin for managing user permission, education, and communication.

A WordPress plugin for managing user permission, education, and communication. Texas A&M University System

Texas A&M University, College of Liberal Arts

1 Oct 22, 2021

WordPress single-page theme with profile patterns.

X3P0 - Reflections A one-page user-profile WordPress theme. Really, it's just a single page. View Demo → Recommended This theme is designed to work wi