roots / acorn-fse-helper
Bootstrap FSE support in Acorn-based WordPress themes.
Fund package maintenance!
roots
Installs: 681
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 4
Forks: 1
Open Issues: 3
Type:package
Requires
- php: >=8.1
Requires (Dev)
- laravel/pint: ^1.15
- roots/acorn: ^4.2
README
Acorn FSE Helper provides an easy way to initialize and work with block templates in themes powered by Acorn.
Requirements
Installation
Install via Composer:
$ composer require roots/acorn-fse-helper
Getting Started
Once installed, begin by initializing full-site editing in your theme using Acorn's CLI:
$ wp acorn fse:init
Initializing ensures your current activated theme supports block-templates
as well as provides you with the option to publish initial stubs to get started with.
Usage
Once initialized, any block templates located in templates/
will be given priority over existing Blade views.
Blade Directives
To assist with hybrid theme development, Acorn FSE Helper includes a few useful Blade directives out of the box for working with blocks inside of views.
@blocks
The @blocks
directive allows you to render raw block markup inside of a view using do_blocks()
:
@blocks <!-- wp:paragraph {"align":"center"} --> <p>Lorem ipsum...</p> <!-- /wp:paragraph --> @endblocks
@blockpart
The @blockpart
directive provides a convenient way to render block template parts inside of your views using block_template_part()
:
@blockpart('header')
To render multiple template parts at once, you may pass an array in the order you wish them to be rendered in:
@blockpart(['header', 'footer'])
Bug Reports
If you discover a bug in Acorn FSE Helper, please open an issue.
Contributing
Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.
License
Acorn FSE Helper is provided under the MIT License.