Lewati ke konten

useBlockProps

Secara default, Gutenberg harus membuat pembungkus di sekitar blok agar interaktif di dalam editor. Hal ini dapat menimbulkan masalah pada beberapa jenis blok seperti kontainer atau kolom, karena markup antara editor dan frontend akan berbeda. Hook useBlockProps memungkinkan Anda menandai elemen di dalam templat blok sebagai elemen root, sehingga markup di editor dan frontend menjadi sama.

Penggunaan

Cukup tambahkan atribut useBlockProps ke elemen root blok Anda.

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

Blockstudio akan otomatis menggabungkan kelas dan atribut dari editor (kelas perataan, dll.) dengan yang ditetapkan di templat blok. get_block_wrapper_attributes digunakan di balik layar untuk itu.

Filter blockstudio/blocks/components/use_block_props/render diterapkan pada pembungkus di jalur render frontend dan editor. Karena itu, kelas yang ditambahkan oleh tema atau integrasi per instans juga muncul di kanvas editor serta markup frontend yang disimpan.

Output:

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

Pertimbangan

Blockstudio mencegah navigasi tautan di dalam editor blok, termasuk target="_blank", klik dengan tombol pengubah, klik tengah, dan aktivasi melalui papan ketik. Peristiwa klik tetap diteruskan ke Gutenberg, sehingga klik biasa memilih blok. RichText tetap dapat diedit. Ini berlaku dengan atau tanpa useBlockProps, termasuk ketika elemen akar blok menggunakan anchor.

Tautan frontend dan perintah menu konteks browser tidak berubah. Anda tidak perlu menghapus tautan dari templat atau membuat percabangan berdasarkan $isEditor.

Elemen Root

Karena hanya boleh ada satu elemen root dalam templat blok, saat menggunakan useBlockProps, templat blok harus memiliki satu elemen root. Contohnya, cara berikut tidak akan berfungsi dan Gutenberg akan membuat pembungkus di sekitar templat.

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

Demikian pula, useBlockProps hanya dapat digunakan sekali per templat blok.

Tanda @

Blockstudio mengonversi templat blok menjadi kode React yang valid di dalam Gutenberg menggunakan html-react-parser. Akibatnya, karakter @ tidak dapat digunakan di dalam nama atribut HTML.

Pustaka seperti Alpine.js menggunakan karakter @ untuk mendefinisikan direktif pada elemen HTML.

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

Di dalam Gutenberg, atribut @click ini akan dihapus dari elemen. (Atribut ini tentu saja tetap berfungsi di frontend.)

Untuk mengatasi masalah ini, Anda dapat menggunakan sintaks alternatif yang disediakan Alpine.js.

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

Cara di atas akan berfungsi di dalam Gutenberg dan di frontend.

Kelas Body Kanvas

Saat assets.reset.enabled aktif, Blockstudio juga menyalin kelas yang telah dibersihkan dan dikembalikan oleh filter body_class milik WordPress ke kanvas editor. Dengan demikian, selektor tema seperti .brand-a .site-card tetap berfungsi di kedua lokasi.

Filter daftar kelas akhir saat editor memerlukan kumpulan yang lebih terbatas:

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

Filter ini hanya mengontrol kelas yang disalin ke kanvas editor. Filter ini tidak mengubah kelas body frontend.