Към съдържанието

useBlockProps

По подразбиране Gutenberg трябва да създаде обвивка около блоковете, за да ги направи интерактивни в редактора. Това може да създаде проблеми при някои типове блокове, като контейнери или колони, тъй като маркировката в редактора ще се различава от тази във фронтенда. Хукът useBlockProps позволява да посочите елемент в шаблона на блока като коренов елемент и така да осигурите еднаква структура на маркировката в редактора и във фронтенда.

Употреба

Просто добавете атрибута useBlockProps към кореновия елемент на блока.

PHP
<div useBlockProps class="my-class">
  <!--
  This element will be rendered
  as the root element of your block
  in Gutenberg.
  -->
</div>

Blockstudio автоматично комбинира класовете и атрибутите от редактора (като класовете за подравняване) с дефинираните в шаблоните на блоковете. За целта вътрешно се използва get_block_wrapper_attributes.

Филтърът blockstudio/blocks/components/use_block_props/render се прилага към обвивката както при изобразяването във фронтенда, така и при това в редактора. Следователно класовете, добавени от тема или интеграция за конкретна инстанция, се появяват както в работното поле на редактора, така и в запазената маркировка във фронтенда.

Резултат:

HTML
<div class="my-class wp-block-your-block-name alignright">
</div>

Съображения

Blockstudio предотвратява навигацията по връзки в редактора на блокове, включително target="_blank", щраквания с модификатор, щраквания с централния бутон и активиране от клавиатурата. Събитията при щракване все още достигат до Gutenberg, така че обикновеното щракване избира блока. RichText остава редактируем. Това важи със или без useBlockProps, включително когато котва се използва като коренов елемент на блока.

Връзките във фронтенда и командите на контекстното меню на браузъра остават непроменени. Не е необходимо да премахвате връзки от шаблоните или да проверявате $isEditor.

Коренов елемент

Тъй като шаблонът на блока може да има само един коренов елемент, при използване на useBlockProps шаблонът трябва да съдържа само един коренов елемент. Например следният вариант няма да работи и Gutenberg ще създаде обвивка около шаблона.

PHP
<div useBlockProps>
  First root element.
</div>
<span>
  Second root element.
</span>

По същия начин useBlockProps може да се използва само веднъж в шаблон на блок.

Знак @

Blockstudio преобразува шаблона на блока във валиден код React в Gutenberg чрез html-react-parser. Поради това знакът @ не може да се използва в име на атрибут HTML.

Библиотеки като Alpine.js използват знаците @, за да задават директиви за елементи HTML.

PHP
<button useBlockProps @click="console.log('hi')">
  Click me
</button>

В Gutenberg този атрибут @click ще бъде премахнат от елемента. (Разбира се, той ще продължи да работи във фронтенда.)

За да заобиколите този проблем, можете да използвате алтернативния синтаксис, който предлага Alpine.js.

PHP
<button useBlockProps x-on:click="console.log('hi')">
  Click me
</button>

Горното ще работи в Gutenberg и във фронтенда.

Класове на тялото на работното поле

Когато assets.reset.enabled е активно, Blockstudio копира и пречистените класове, върнати от филтъра body_class на WordPress, в работното поле на редактора. Така селектори на тема като .brand-a .site-card работят и на двете места.

Филтрирайте крайния списък с класове, когато редакторът има нужда от по-ограничен набор:

PHP
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
  return array_values(array_diff($classes, ['logged-in']));
});

Този филтър контролира само класовете, копирани в работното поле на редактора. Той не променя класовете на тялото във фронтенда.