Memfilter Atribut
Blockstudio menyediakan dua metode untuk memfilter atribut blok.
Definisi Atribut
blockstudio/blocks/attributes memfilter setiap definisi field, sedangkan Blockstudio membangun dan mendaftarkan blok. Gunakan untuk menyesuaikan kontrol editor, nilai default, kondisi, opsi, dan definisi yang digunakan untuk memvalidasi nilai saat rendering.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
if (
($block['name'] ?? '') === 'my-theme/code-block' &&
($attribute['id'] ?? '') === 'lineNumbers'
) {
$attribute['default'] = true;
$attribute['conditions'] = [
[
[
'id' => 'language',
'operator' => '==',
'value' => 'css'
]
]
];
}
return $attribute;
}, 10, 2);
Kode di atas menetapkan nilai default lineNumbers menjadi true dan menyembunyikan field kecuali jika language ditetapkan menjadi css.
Callback menerima satu definisi field pada setiap pemanggilan, termasuk field grup dan repeater bertingkat. Callback berjalan saat pendaftaran blok, bukan pada setiap rendering frontend.
Definisi opsi yang difilter juga digunakan oleh peta atribut render. Misalnya, opsi yang ditambahkan ke field select, radio, atau checkbox tersedia di editor dan tetap valid saat Blockstudio mengambil nilai tersimpan untuk template:
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
if (
($block['name'] ?? '') === 'bsui/button' &&
($attribute['id'] ?? '') === 'variant'
) {
$attribute['options'][] = [
'label' => 'Brand',
'value' => 'brand',
];
}
return $attribute;
}, 10, 2);
Nilai yang Dirender
blockstudio/blocks/attributes/render memfilter nilai terselesaikan dari satu kolom tepat sebelum diteruskan ke templat blok. Filter ini berjalan sekali untuk setiap kolom, sehingga callback menerima nilai, kunci kolom, dan data blok.
add_filter('blockstudio/blocks/attributes/render', function($value, $key, $block) {
if (($block['name'] ?? '') === 'my-theme/code-block' && 'lineNumbers' === $key) {
return true;
}
return $value;
}, 10, 3);
Contoh di atas mengganti nilai apa pun yang disimpan di editor untuk lineNumbers.
Daftarkan callback dengan tiga argumen yang diterima (argumen terakhir dari add_filter); jika tidak, WordPress hanya meneruskan nilai.
$value: nilai kolom yang telah terselesaikan, dalam bentuk yang diterima templat sebagai$a[$key]. Kembalikan nilai yang seharusnya diterima templat.$key: kunci kolom, seperti yang digunakan dalam$a. Di dalam baris repeater, ini adalah ID kolom di dalam baris tersebut.$block: larik data blok yang diterima templat sebagai$blockatau$b, denganid,name,postId,postType,index,indexTotal,context, dan penanda island. Untuk ekstensi yang diterapkan pada blok yang bukan blok Blockstudio,$blockhanya berisi entriblockstudio(attributesdandisabled) dan tidak memilikiname.
Filter ini juga berjalan untuk atribut yang bukan kolom Blockstudio, seperti className dan anchor, serta untuk <id>__size pendamping kolom file, jadi bandingkan $key sebelum mengubah nilai. Nilai yang dikembalikan hanya menggantikan nilai $key; filter tidak dapat menambahkan kunci baru ke $a.
Gunakan filter definisi saat mengubah konfigurasi kolom, dan filter perenderan saat menghitung atau mengganti nilai templat untuk suatu permintaan.
Saat nilai dibaca melalui bs_block_values() alih-alih dirender, filter ini hanya menerima nama blok di $block.
Penghitung perenderan dan metadata lain yang hanya digunakan saat perenderan tidak dibuat oleh helper tersebut.