underpin/block-loader

Block Loader for Underpin

1.2.0 2021-11-23 14:21 UTC

Requires

• underpin/script-loader: ^1.1
• underpin/style-loader: ^1.0
• underpin/underpin: ^2.0

GPL-2.0-or-later

• Alex Standiford

README

Loader That assists with adding blocks to a WordPress website.

Installation

Using Composer

composer require underpin/block-loader

Manually

This plugin uses a built-in autoloader, so as long as it is required before Underpin, it should work as-expected.

require_once(__DIR__ . '/underpin-blocks/blocks.php');

Setup

1. Install Underpin. See Underpin Docs
2. Register new blocks menus as-needed.

Example

A very basic example could look something like this. Note that your block will not display unless registered in Javascript as well.

// Register styles and scripts.
underpin()->styles()->add( 'test-style', [/*...*/] );
underpin()->scripts()->add( 'test-script', [/*...*/] );

// Register block
underpin()->blocks()->add( 'test', [
	'name'        => 'Test Block',
	'description' => 'Description for block.',
	'type'        => underpin()->dir() . 'block.json', // Can be the block ID or a link to a block.json file. See register_block_type
	'args'        => [],                               // Optional. See register_block_type
] );

Alternatively, you can extend Block and reference the extended class directly, like so:

underpin()->blocks()->add('block-key','Namespace\To\Class');