Gå til indhold

useBlockProps

Som standard skal Gutenberg oprette en wrapper omkring blokke, så de bliver interaktive i editoren. Det kan give problemer for visse bloktyper som containere eller kolonner, da markupen i editoren og i frontend så er forskellig. Hooket useBlockProps gør det muligt at markere et element i blokskabelonen som rodelement og dermed skabe samme markup i editoren og i frontend.

Brug

Føj blot attributten useBlockProps til rodelementet i din blok.

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

Blockstudio kombinerer automatisk klasser og attributter fra editoren (justeringsklasser osv.) med det, der er defineret i blokskabelonerne. get_block_wrapper_attributes bruges til dette i baggrunden.

Filteret blockstudio/blocks/components/use_block_props/render anvendes på wrapperen både ved gengivelse i frontend og i editoren. Klasser, der tilføjes af et tema eller en integration for den enkelte instans, vises derfor både på editorens lærred og i den gemte markup til frontend.

Output:

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

Overvejelser

Blockstudio forhindrer linknavigation i blokeditoren, herunder target="_blank", klik med modifikatortaster, midterklik og aktivering via tastaturet. Klikhændelser når stadig frem til Gutenberg, så almindelige klik vælger blokken. RichText kan stadig redigeres. Dette gælder både med og uden useBlockProps, herunder når et anker bruges som blokkens rodelement.

Links på frontend og browserens kommandoer i kontekstmenuen er uændrede. Du behøver ikke at fjerne links fra skabeloner eller forgrene på $isEditor.

Rodelement

Da der kun kan være ét rodelement i en blokskabelon, skal blokskabelonen have ét enkelt rodelement, når du bruger useBlockProps. Følgende vil for eksempel ikke fungere, og Gutenberg opretter en wrapper omkring skabelonen.

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

På samme måde kan useBlockProps kun bruges én gang pr. blokskabelon.

@-tegn

Blockstudio konverterer blokskabelonen til gyldig React-kode i Gutenberg ved hjælp af html-react-parser. Det betyder, at tegnet @ ikke kan bruges i et attributnavn HTML.

Biblioteker som Alpine.js bruger tegnet @ til at definere direktiver på elementer af typen HTML.

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

I Gutenberg fjernes denne attribut @click fra elementet. (Den fungerer selvfølgelig stadig i frontend.)

Du kan løse dette problem ved at bruge den alternative syntaks, som Alpine.js tilbyder.

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

Ovenstående fungerer både i Gutenberg og i frontend.

Klasser på lærredets body

Når assets.reset.enabled er aktiv, kopierer Blockstudio også de rensede klasser, som returneres af filteret body_class fra WordPress, til blokeditorens lærred. Dermed fungerer temavælgere som .brand-a .site-card begge steder.

Filtrér den endelige klasseliste, når editoren har brug for et mindre udvalg:

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

Dette filter styrer kun, hvilke klasser der kopieres til editorens lærred. Det ændrer ikke body-klasserne i frontend.