README

‼️	WARNING! This plugin is probably unstable since it fiddles its way around to find React instances in the page.

Now that you've been warned: Hey, welcome! For those of you who use block styles and ACF Blocks, you probably wonder why it's not possible to register a group field for a specific block style.

The simple reason is probably because it's unreliable right now in the current Gutenberg APIs (2021-12-20), but it might change soon. In the meantime, I've hacked around this solution that 1) caches the block styles as a transient; 2) finds the ACF form React instance in the dom; 3) forces the refresh of the ACF form when we click a block style.

This is far from perfect, but if it can be of any use to someone, good!

Requirements

Composer

Installation

Install via Composer:

composer require davidwebca/acf-block-style-location

Or simply download zip of this repo and place in your plugins directory!

Setup

You'll need to first visit a Gutenberg-enabled page to prune the block styles cache. This is simply because WordPress doesn't allow fetching Block Styles on non-gutenberg pages (yet) since they can still be registered from the JavaScript API only. ACF adheres to that and only activates its block functionalities on Gutenberg-enabled pages.

Once you've done that, you can go back to the admin and fill in your Field Groups with the block location and then the block style location. Only the block style location should work though since all the block styles are namespaced.

The value to pass, for those who use PHP or ACF Builder to register their fields, is as follows:

$acfBuilder->setLocation('acf_block_style', '==', 'acf/blockname:stylename');

Example:

$acfBuilder->setLocation('acf_block_style', '==', 'acf/postlist:default'); /* Block style class is "is-style-default" */

Also possible to negate:

$acfBuilder->setLocation('acf_block_style', '!=', 'acf/postlist:default'); /* Block style class is "is-style-default" */

Bug Reports and contributions

All issues can be reported right here on github and I'll take a look at it. I don't intend on maintaining this a lot this the APIs will vastly change in the next few releases of Gutenberg, but please don't hesitate to ask around and create issues on Github. Make sure to give as many details as possible since I'm working full-time and will only look at them once in a while. Feel free to add the code yourself with a pull request.

License

This code is provided under the MIT License.

davidwebca / acf-block-style-location

Maintainers

Details