Vai al contenuto

useBlockProps

Per impostazione predefinita, Gutenberg deve creare un wrapper attorno ai blocchi per renderli interattivi nell’editor. Questo può creare problemi con alcuni tipi di blocco, come i contenitori o le colonne, perché il markup dell’editor sarà diverso da quello del frontend. L’hook useBlockPropsuseBlockProps permette di indicare un elemento interno al template del blocco come elemento radice, creando così una corrispondenza del markup tra editor e frontend.

Utilizzo

Aggiungete semplicemente l’attributo useBlockProps all’elemento radice del blocco.

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

Blockstudio combina automaticamente le classi e gli attributi dell’editor (classi di allineamento e simili) con quelli definiti nei template dei blocchi. A questo scopo viene usato internamente get_block_wrapper_attributes.

Il filtro blockstudio/blocks/components/use_block_props/render viene applicato al wrapper sia nel frontend sia nel percorso di rendering dell’editor. Le classi aggiunte da un tema o da un’integrazione specifica per istanza compaiono quindi sia nel canvas dell’editor sia nel markup salvato del frontend.

Output:

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

Considerazioni

Blockstudio impedisce la navigazione dei link nell’editor dei blocchi, inclusi target="_blank", i clic con modificatore, i clic con il pulsante centrale e l’attivazione da tastiera. Gli eventi di clic raggiungono comunque Gutenberg, quindi i normali clic selezionano il blocco. RichText resta modificabile. Questo vale con o senza useBlockProps, anche quando un anchor è usato come elemento radice del blocco.

I link nel frontend e i comandi del menu contestuale del browser restano invariati. Non è necessario rimuovere i link dai template né fare un controllo su $isEditor.

Elemento radice

Poiché in un template di blocco può esserci un solo elemento radice, quando usate useBlockProps il template deve averne uno solo. Per esempio, quanto segue non funzionerà e Gutenberg creerà un wrapper attorno al template.

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

Allo stesso modo, useBlockProps può essere usato una sola volta per template di blocco.

Simbolo @

Blockstudio converte il template del blocco in codice React valido all’interno di Gutenberg, usando html-react-parser. Ciò comporta la limitazione che il carattere @ non può essere usato nel nome di un attributo HTML.

Librerie come Alpine.js usano i caratteri @ per definire direttive sugli elementi HTML.

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

All’interno di Gutenberg, questo attributo @click verrà rimosso dall’elemento (naturalmente continuerà a funzionare nel frontend).

Per risolvere questo problema, potete usare la sintassi alternativa fornita da Alpine.js.

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

Quanto sopra funzionerà all’interno di Gutenberg e nel frontend.

Classi del body del canvas

Quando assets.reset.enabled è attivo, Blockstudio copia anche nel canvas dell’editor le classi sanificate restituite dal filtro body_class di WordPress. In questo modo i selettori del tema, come .brand-a .site-card, funzionano in entrambi i contesti.

Filtrate l’elenco finale delle classi quando nell’editor serve un insieme più ristretto:

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

Questo filtro controlla solo le classi copiate nel canvas dell’editor. Non modifica le classi del body del frontend.