Hook PHP
Di bawah ini adalah daftar semua hook PHP yang tersedia untuk memperluas atau menyesuaikan fungsionalitas plugin.
Jalur
Filter ini memungkinkan Anda menyesuaikan jalur folder blok. Secara default, folder ini berada di blockstudio dalam tema yang sedang aktif. Sebagai alternatif, Anda dapat membuat instans baru untuk beberapa direktori sumber.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Init
global
Action ini dijalankan setelah plugin mendaftarkan semua blok.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
instance
Action ini dijalankan setelah plugin mendaftarkan semua blok dari instans tertentu.
Segmen $instance adalah jalur instans yang relatif terhadap wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
Action ini dijalankan sebelum plugin mendaftarkan semua blok.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
Action ini dijalankan sebelum plugin mendaftarkan semua blok dari instans tertentu.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Blok
render
Filter ini memungkinkan Anda menyesuaikan output blok sebelum dirender.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
meta
Filter ini memungkinkan Anda menyesuaikan data berkas block.json sebelum didaftarkan.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Kode di atas akan mengubah ikon semua blok yang diawali marketing.
conditions
Filter ini memungkinkan Anda menambahkan kondisi khusus yang dapat digunakan di dalam blok. Setiap jenis kondisi dipetakan ke nilai yang dibandingkan editor dengan value kondisi tersebut. Lihat Kondisi Khusus.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
attributes
Filter ini menyesuaikan definisi satu field sebelum blok didaftarkan. Definisi yang telah difilter menentukan kontrol editor dan validasi nilai saat rendering. Lihat Pemfilteran untuk informasi lebih lanjut.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
Filter ini menyesuaikan nilai satu field sebelum diteruskan ke template blok. Filter berjalan sekali untuk setiap field dan menerima tiga argumen: $value (nilai yang telah di-resolve), $key (key field, seperti yang digunakan di $a) dan $block (array data blok yang diterima template sebagai $block atau $b). Daftarkan dengan tiga argumen yang diterima. Lihat Pemfilteran untuk informasi selengkapnya.
add_filter('blockstudio/blocks/attributes/render', function($value, $key, $block) {
// Modify the value of one field before rendering.
return $value;
}, 10, 3);
attributes/files/sizes
Field files mengembalikan setiap gambar dengan array sizes yang memuat URL, lebar, dan tinggi full serta setiap ukuran gambar yang terdaftar, misalnya $image['sizes']['thumbnail'] dan $image['sizes']['thumbnail-width']. Setiap ukuran memicu satu pemanggilan wp_get_attachment_image_src() untuk setiap gambar, sehingga filternya tetap berlaku. Template yang tidak pernah membaca sizes dapat menghapus atau mempersingkat daftar.
add_filter('blockstudio/blocks/attributes/files/sizes', function($sizes, $id, $size) {
// Keep only two sizes. Return an empty array to skip them, `sizes` is then null.
return ['full', 'large'];
}, 10, 3);
$sizes adalah daftar nama ukuran, dengan full di urutan pertama (kosong jika tidak ada ukuran antara yang terdaftar). $id adalah ID lampiran dan $size adalah ukuran yang diminta untuk url nilainya. Filter ini mengubah array sizes dari setiap nilai files dalam permintaan. Tanpanya, array tidak berubah.
Kembalikan nama ukuran sebagai string. Entri yang tidak valid akan diabaikan, nama duplikat hanya diselesaikan satu kali, dan nilai kembalian yang bukan array akan melewati ukuran. Properti lampiran yang diminta url dan properti lainnya tidak berubah. Hook ini tidak dijalankan untuk field files dengan returnFormat: "url", yang tidak membuat peta ukuran.
attributes/validate
Sesuaikan temuan dari pemanggilan eksplisit bs_validate_block(), misalnya saat filter render kustom menyelesaikan referensi tersimpan. Ini tidak mengaktifkan validasi otomatis saat penyimpanan atau render.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Kembalikan daftar temuan. Filter tidak dipanggil saat blok tidak memiliki field Blockstudio atau ekstensi yang cocok (null).
attributes/schema
Sesuaikan Schema JSON yang dikembalikan oleh filter render khususbs_block_schema(), misalnya saat filter render khusus menyelesaikan referensi tersimpan.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Kembalikan larik schema. Filter tidak dipanggil jika blok tidak memiliki field Blockstudio atau ekstensi yang cocok (null).
attributes/populate
Filter ini memungkinkan Anda menambahkan data khusus ke opsi field checkbox, select, atau radio. Lihat Mengisi opsi untuk informasi lebih lanjut.
Filter ini menerima satu argumen: array berisi semua kumpulan data khusus, dengan kunci berupa nama yang digunakan di "populate": {"type": "custom", "custom": "myCustomOptions"}.
add_filter('blockstudio/blocks/attributes/populate', function($options) {
$options['myCustomOptions'] = [
['value' => '1', 'label' => 'Option 1'],
['value' => '2', 'label' => 'Option 2'],
];
return $options;
});
components/use_block_props/render
Filter ini memungkinkan Anda menyesuaikan output konten useBlockProps.
Semua filter komponen (use_block_props, inner_blocks, dan rich_text) menerima blok sebagai argumen terakhir. $block adalah WP_Block_Type yang terdaftar untuk blok yang sedang dirender, jadi $block->name adalah nama blok, misalnya acme/hero.
$props adalah string berisi atribut HTML, bukan array. Di frontend, nilainya adalah hasil dari get_block_wrapper_attributes(), misalnya class="wp-block-acme-hero my-class". Di editor, nilainya adalah atribut class dari elemen. Kembalikan string. Di editor, hanya atribut class dari string yang dikembalikan yang diterapkan.
add_filter('blockstudio/blocks/components/use_block_props/render', function($props, $block) {
if ($block->name !== 'acme/hero') {
return $props;
}
return str_replace('class="', 'class="my-custom-class ', $props);
}, 10, 2);
components/inner_blocks/render
Filter ini memungkinkan Anda menyesuaikan output konten <InnerBlocks />.
add_filter('blockstudio/blocks/components/inner_blocks/render', function($content, $block) {
return '<div class="inner-wrapper">' . $content . '</div>';
}, 10, 2);
components/inner_blocks/frontend/wrap
Filter ini memungkinkan Anda menghapus pembungkus <InnerBlocks /> dari frontend.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
Filter ini memungkinkan Anda menyesuaikan keluaran konten <RichText />. Filter ini menerima nilai atribut dan blok.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Tag Blok
blockstudio/block_tags/builders
Filter ini mendaftarkan builder array blok yang digunakan oleh tag blok dan blok kustom yang dipilih melalui blockstudio/parser/element_mapping. Setiap builder menerima atribut yang telah diurai dan konten dalam mentah.
add_filter('blockstudio/block_tags/builders', function($builders, $parser) {
$builders['theme/paragraph'] = function(array $attributes, string $inner) {
$attributes['content'] = trim($inner);
return [
'blockName' => 'theme/paragraph',
'attrs' => [
'blockstudio' => [
'attributes' => $attributes,
],
],
'innerBlocks' => [],
'innerHTML' => '',
'innerContent' => [],
];
};
return $builders;
}, 10, 2);
Filter blockstudio/block_tags/renderers dan blockstudio/parser/renderers yang kompatibel berjalan setelah hook ini dan dapat mengganti nama blok yang sama.
blockstudio/block_tags/tag_aliases
Filter ini memungkinkan Anda mendaftarkan tag authoring bergaris khusus yang mengarah ke nama blok sebenarnya sebelum fallback HTML mentah. Ini berguna ketika tema menginginkan sintaks tag khusus proyek yang ringkas, tetapi tetap merender blok standar Blockstudio atau blok inti.
add_filter('blockstudio/block_tags/tag_aliases', function($aliases) {
$aliases['theme-button'] = 'bsui/button';
$aliases['theme-card'] = 'theme/card';
return $aliases;
});
<theme-button href="/download" label="Download" />
<theme-card title="Fast authoring">
<p>Children are parsed as nested blocks.</p>
</theme-card>
blockstudio/block_tags/prefixes
Filter ini memungkinkan Anda memetakan singkatan awalan ke satu atau beberapa namespace blok. Setiap kunci adalah awalan huruf kecil tanpa tanda hubung. Setiap nilai dapat berupa string namespace atau daftar namespace berurutan.
add_filter('blockstudio/block_tags/prefixes', function($prefixes) {
$prefixes['theme'] = ['theme-components', 'bsui'];
return $prefixes;
});
<theme-card title="Homepage" />
<theme-button label="Get started" />
<theme-ui-feature-matrix />
<theme-card> mengarah ke theme-components/card. <theme-button> mencoba theme-components/button terlebih dahulu, lalu beralih ke bsui/button. Entri blockstudio/block_tags/tag_aliases eksplisit diprioritaskan untuk tag yang sama, dan tag berawalan yang tidak ditemukan dibiarkan apa adanya.
Awalan dapat dirangkai: jika tag berawalan tidak ditemukan secara langsung dan slug-nya sendiri merupakan tag awalan terdaftar, resolusi akan berlanjut secara rekursif. Dengan theme => ['theme-components'] dan ui => ['bsui'], <theme-ui-input> beralih ke awalan ui dan mengarah ke bsui/input. Tag awalan dan alias terdaftar juga dirender dalam output templat blok, bukan hanya di konten halaman.
Pengaturan
path
Filter ini memungkinkan Anda menyesuaikan path file blockstudio.json. Secara default, file ini berada di blockstudio.json dalam tema yang sedang aktif.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
Filter ini memungkinkan Anda mengaktifkan editor untuk ID pengguna tertentu.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
Filter ini memungkinkan Anda mengaktifkan editor untuk peran pengguna tertentu.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan pemuatan aset di frontend dan editor.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan penghapusan gaya blok inti WordPress dan reset tata letak utilitas editor.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
Filter ini memungkinkan Anda mengontrol jenis post yang menggunakan pengeditan lebar penuh.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan minifikasi CSS.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan minifikasi JS.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan pemrosesan SCSS dalam file .css.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan pemrosesan file .scss menjadi CSS.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
Filter ini memungkinkan Anda mengontrol lokasi penulisan aset blok yang telah dikompilasi.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
Filter ini memungkinkan Anda mengontrol berapa banyak byte CSS blok eksternal yang disisipkan secara inline pada setiap halaman.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan semua cache aset runtime dan editor berbasis file Blockstudio.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
Filter ini memungkinkan Anda mengubah direktori cache berbasis file Blockstudio.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
Filter ini memungkinkan Anda mengubah durasi penyimpanan namespace cache yang sudah tidak digunakan sebelum dibersihkan.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
Filter ini menampilkan apakah hook commit PHPStan milik Blockstudio diaktifkan.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan Sinkronisasi Konten.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Filter ini memungkinkan Anda mengatur namespace kepemilikan Sinkronisasi Konten.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Filter ini memungkinkan Anda mengatur direktori file Sinkronisasi Konten.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Filter ini memungkinkan Anda menyertakan atau mengecualikan post yang dikelola Sinkronisasi Halaman.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Filter ini memungkinkan Anda mengonfigurasi penanganan penulis Sinkronisasi Konten.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Filter ini memungkinkan Anda mengonfigurasi daftar izin jenis post untuk Sinkronisasi Konten.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Filter ini memungkinkan Anda mengonfigurasi daftar izin taksonomi untuk Sinkronisasi Konten.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Filter ini memungkinkan Anda mengonfigurasi penanganan media Sinkronisasi Konten.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan Tailwind.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
Filter ini memungkinkan Anda menambahkan konfigurasi Tailwind CSS kustom.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
Filter ini memungkinkan Anda memilih output Tailwind CSS inline atau tertaut.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan komponen UI yang dibundel.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan pemformatan kode saat menyimpan.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
Filter ini memungkinkan Anda memuat aset tambahan di editor.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
Filter ini memungkinkan Anda menambahkan markup tambahan di akhir editor.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
Filter ini memungkinkan Anda menonaktifkan pemuatan blok di dalam Block Editor.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
Filter ini memungkinkan Anda mengaktifkan fitur bantuan editor Blockstudio seperti gaya fokus yang lebih bersih serta garis luar hover/pemilihan.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
Filter ini memungkinkan Anda menambahkan stylesheet yang kelasnya dapat dipilih di kolom kelas.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
Filter ini memungkinkan Anda menambahkan stylesheet yang variabel CSS-nya tersedia untuk pelengkapan otomatis di kolom kode.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
Filter ini memungkinkan Anda mengontrol nama blok yang diizinkan di inserter.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
Filter ini memungkinkan Anda menghapus nama blok dari inserter.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
Filter ini memungkinkan Anda mengaktifkan atau menonaktifkan aset direktori blok WordPress di editor.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
Filter ini memungkinkan Anda mengontrol slug kategori blok yang tetap tersedia.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Filter ini memungkinkan Anda menghapus slug kategori blok dari inserter.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Filter ini memungkinkan Anda mengganti nama label kategori blok berdasarkan slug.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Filter ini memungkinkan Anda mengurutkan slug kategori blok di inserter.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
Filter ini memungkinkan Anda membatalkan pendaftaran gaya blok yang didaftarkan oleh PHP berdasarkan nama blok.
add_filter('blockstudio/settings/block_editor/blocks/styles/deny', function() {
return [
'my-theme/card' => ['outline'],
'my-theme/media' => ['framed']
];
});
block_editor/blocks/legacy_widgets/hide
Filter ini memungkinkan Anda menyembunyikan widget lawas tambahan dari blok widget lawas.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
Filter ini memungkinkan Anda mengaktifkan atau menonaktifkan pola blok inti WordPress.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
Filter ini memungkinkan Anda mengaktifkan atau menonaktifkan pola jarak jauh dari direktori pola WordPress.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
Filter ini memungkinkan Anda mengaktifkan atau menonaktifkan pola blok yang disediakan tema.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
Filter ini memungkinkan Anda mengaktifkan atau menonaktifkan pola berbasis file Blockstudio.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
Filter ini memungkinkan Anda mengontrol slug kategori pola yang tetap tersedia.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Filter ini memungkinkan Anda menghapus slug kategori pola dari inserter pola.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Filter ini memungkinkan Anda mengganti nama label kategori pola berdasarkan slug.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Filter ini memungkinkan Anda mengurutkan slug kategori pola di inserter.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
Filter ini memungkinkan Anda mengaktifkan atau menonaktifkan kategori media Openverse di inserter media editor blok.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
Filter ini memungkinkan Anda mengontrol nama ukuran gambar yang tetap tersedia di kontrol media editor.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
Filter ini memungkinkan Anda menghapus nama ukuran gambar dari kontrol media editor.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
Filter ini memungkinkan Anda mengaktifkan atau menonaktifkan pembuatan file konteks untuk integrasi alat LLM. Jika diaktifkan, file konteks menggabungkan data blok terkini, pengaturan Blockstudio dari instalasi saat ini, semua skema yang relevan, dan dokumentasi Blockstudio menjadi satu sumber untuk digunakan dengan alat pengembangan AI.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan perenderan tag blok di tingkat halaman.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
Filter ini memungkinkan Anda mendaftarkan singkatan awalan ke namespace untuk tag blok.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan perebut elemen.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan profiler performa.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
Filter ini memungkinkan Anda mengaktifkan/menonaktifkan kanvas.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
Filter ini memungkinkan Anda menampilkan/menyembunyikan bilah admin WordPress di kanvas.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Memfilter label setiap kunci yang ditulis oleh wp bs wpml config. Lihat Ubah label untuk array konteks.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Kanvas
blockstudio/canvas/inventory
Filter ini menyesuaikan inventaris yang dilaporkan Kanvas untuk suatu pilihan. Callback menerima DTO inventaris, pilihan awal, dan opsi yang diberikan saat callback dipanggil.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
Filter ini menyesuaikan dokumen hasil render yang dikembalikan Kanvas, dengan tiga argumen yang sama seperti filter inventaris.
blockstudio/canvas/item_loaded
Aksi ini dijalankan sekali untuk setiap rekaman inventaris saat dimuat, dengan menerima jenis inventaris, ID rekaman kanonis, dan rekaman yang telah dinormalisasi.
blockstudio/canvas/source_compiled
Aksi ini dijalankan setelah file sumber dikompilasi untuk Kanvas, dengan menerima path sumber yang dipilih dan rekaman sumber kanonis.
UI yang Dibundel
blockstudio/ui/directories
Filter ini menyesuaikan direktori yang dipindai untuk komponen UI yang dibundel.
blockstudio/ui/inventory
Filter ini menyesuaikan inventaris keluarga UI publik.
blockstudio/ui/examples
Filter ini menyesuaikan rekaman contoh UI, dengan menerima contoh dan inventaris UI publik sebagai sumbernya.
Topologi
blockstudio/blocks/topology_refreshed
Aksi ini dijalankan setelah topologi blok dibangun ulang.
blockstudio/pages/topology_refreshed
Aksi ini dijalankan setelah topologi halaman dibangun ulang.
blockstudio/pages/layout_error
Aksi ini dijalankan saat tata letak halaman gagal dirender, alih-alih gagal tanpa pemberitahuan.
Runtime
blockstudio/runtime/initialized
Aksi ini dijalankan setelah runtime menyelesaikan konfigurasi.
blockstudio/runtime/changed
Aksi ini dijalankan ketika identitas runtime yang telah ditetapkan berubah, yang memindahkan namespace cache dan status prarender statis.
blockstudio/performance/default_config
Filter ini menyesuaikan nilai default performa sebelum nilai blockstudio.json milik proyek ditambahkan di atasnya.
Konten
blockstudio/content/orphan_action
Filter ini menentukan tindakan Sinkronisasi Konten terhadap rekaman yang tidak lagi memiliki sumber.
Bootstrap
blockstudio/url
Filter ini mengubah URL publik yang digunakan untuk aset editor dan admin milik Blockstudio. Integrasi Composer harus mendaftarkannya sebelum memuat file autoload Blockstudio. Argumen kedua adalah direktori paket fisik.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Cache Runtime
blockstudio/cache/dir
Filter ini menerima direktori dasar cache yang telah ditetapkan sebelum cakupan runtime, aset editor, atau cache lainnya ditambahkan.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
Filter ini menambahkan varian runtime yang dapat diserialisasi ke identitas cache. Gunakan saat sumber penemuan yang sama dapat memilih inventaris logis yang berbeda.
add_filter('blockstudio/cache/context', function($context, string $scope) {
return [
'preview' => get_query_var('preview_id'),
'site' => get_current_blog_id(),
];
}, 10, 2);
blockstudio/cache/site_key
Filter ini mengubah identitas direktori network/blog untuk host dengan batas tenant sendiri. Nilai yang dikembalikan akan disanitasi sebelum digunakan.
add_filter(
'blockstudio/cache/site_key',
function(string $key, int $networkId, int $blogId) {
return sprintf('tenant-%d-%d', $networkId, $blogId);
},
10,
3
);
blockstudio/runtime/identity
Filter ini menambahkan fakta host yang memengaruhi setiap objek dalam cakupan runtime. Fingerprint sumber khusus item sebaiknya diteruskan sebagai dependensi eksplisit oleh API yang memilikinya.
add_filter(
'blockstudio/runtime/identity',
function(array $identity, string $scope) {
$identity['deployment'] = getenv('RELEASE_SHA') ?: 'local';
return $identity;
},
10,
2
);
blockstudio/cache/watch_debounce
Memfilter jumlah detik snapshot file-watch tervalidasi dapat digunakan kembali tanpa pemeriksaan stat sistem file lagi. Default-nya adalah 0 di lingkungan lokal dan pengembangan, serta 20 di lingkungan lain.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Memfilter berapa lama, dalam milidetik, permintaan menunggu builder serentak menerbitkan cache runtime atau penyegaran pilihan terisi sebelum proses menurunkan kualitas. Default-nya adalah 5000 untuk pembangunan ulang struktural dan 4000 untuk penyegaran pilihan.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Memfilter berapa detik lonjakan penulisan konten, term, pengguna, atau meta digabungkan menjadi satu penyegaran pilihan terisi. Penulisan pertama setelah periode tenang langsung memicu penyegaran; penulisan terakhir dalam satu lonjakan akan tercermin setelah jendela waktu berlalu. Default-nya adalah 30. Kembalikan 0 untuk menyegarkan setiap kali ada penulisan.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Memfilter kunci meta yang penulisannya tidak pernah memperbarui pilihan yang sudah terisi. Secara default, kunci berikut ditulis oleh WordPress sebagai pencatatan aktivitas pengeditan dan login: _edit_lock, diperbarui oleh editor dan Heartbeat saat sebuah pos terbuka; _edit_last, ditulis bersamaan dengan penyimpanan pos yang sudah memicu pembaruan; dan session_tokens, ditulis saat login dan logout. Tambahkan kunci yang sering berubah tetapi tidak pernah memengaruhi kueri pengisian.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Memfilter jumlah payload yang diterbitkan dan disimpan setiap cakupan cache runtime.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Memfilter apakah muatan cache menggunakan data serialisasi terkompresi alih-alih array PHP biasa. Secara default, hanya muatan hingga 1 MiB yang menggunakan format biasa, dan itu pun hanya jika memori bersama OPcache aktif dapat menyimpan tujuan di cache. Proses lain, file yang dikecualikan, dan muatan yang lebih besar menggunakan kompresi.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Mengembalikan false juga mengabaikan batas ukuran. Ini dapat membantu saat WP-CLI tanpa opcache.enable_cli menyiapkan file untuk worker web yang mengaktifkan OPcache, tetapi setiap pembaca tanpa OPcache akan mengurai array yang dihasilkan. Tetap gunakan kompresi untuk muatan besar yang digunakan bersama, kecuali biaya memori tambahan tersebut dapat diterima. Lihat format muatan cache untuk perlindungan default.
blockstudio/cache/protected_paths
Pemangkasan retensi path cache tidak boleh menghapus file. Blockstudio mengisinya dengan setiap file yang dirujuk oleh peta layanan awal yang terpasang.
add_filter('blockstudio/cache/protected_paths', function(array $paths, string $scope, string $directory) {
if ('static-prerender' === $scope) {
$paths[] = $directory . '/pinned.html';
}
return $paths;
}, 10, 3);
blockstudio/cache/outcome
Aksi ini melaporkan cakupan cache bersama dan hasil seperti hit, build, miss-stale, stale-last-good, atau write-failure.
add_action('blockstudio/cache/outcome', function(string $scope, string $reason) {
my_metrics()->increment("blockstudio.cache.{$scope}.{$reason}");
}, 10, 2);
blockstudio/static_prerender/request_bypass
Filter ini menerima keputusan keamanan anonim final beserta input server dan cookie. Mengembalikan true selalu melewati penyajian dan pembuatan statis.
add_filter(
'blockstudio/static_prerender/request_bypass',
function(bool $bypass, array $server, array $cookies) {
return $bypass || isset($cookies['commerce_session']);
},
10,
3
);
blockstudio/static_prerender/public_urls
Filter ini menyediakan atau menyesuaikan inventaris URL publik lengkap yang digunakan oleh penghangat terjadwal dan alat graf eksplisit.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
Nilai yang dikembalikan filter bukan inventaris final. Hasilnya akan melewati pemeriksaan kelayakan cache yang menghapus apa pun yang cocok dengan path dinamis yang dikonfigurasi, serta apa pun yang dilewati secara default: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, path apa pun yang memuat /feed/, dan hasil pencarian di bawah basis pencarian pada path beranda situs (default-nya /search/). Karena itu, URL yang Anda tambahkan dapat dihapus tanpa peringatan. Jika rute yang Anda harapkan tidak ada dalam inventaris yang dibangun, periksa aturan tersebut sebelum menganggap filternya tidak berjalan.
blockstudio/static_prerender/render_internal
Filter ini menerapkan transport batch dalam proses yang bersifat opsional. Kembalikan larik hasil yang dinormalisasi atau biarkan nilainya tanpa perubahan agar renderer menggunakan fallback HTTP yang dikonfigurasi. Hasilnya memuat html dan secara opsional status, dependencies, virtualHashes, serta headers; header yang disebutkan dalam performance.staticPrerender.replayHeaders disimpan bersama dokumen.
add_filter(
'blockstudio/static_prerender/render_internal',
function($result, string $url, array $options) {
return my_static_renderer()->render($url, $options);
},
10,
3
);
blockstudio/static_prerender/cacheable_html
Filter ini membuat keputusan final setelah Blockstudio memverifikasi bahwa output adalah dokumen HTML lengkap tanpa penanda no-cache dan bahwa status respons yang diamati menunjukkan keberhasilan. Argumen ketiga adalah status yang diamati, atau null jika tidak ada status yang dinyatakan.
add_filter('blockstudio/static_prerender/cacheable_html', function(bool $cacheable, string $html, ?int $status) {
return $cacheable && !str_contains($html, 'data-personalized');
}, 10, 3);
blockstudio/static_prerender/outcome
Aksi ini melaporkan hasil prarender statis, termasuk cache hit, cache miss, penulisan, penulisan graf, entri usang, dan kegagalan.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Memfilter jumlah maksimum entri Tailwind CSS yang dikompilasi. Default-nya adalah 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Memfilter usia maksimum entri Tailwind CSS yang dikompilasi dalam detik. Default-nya 30 hari dan minimumnya satu jam.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Admin
diaktifkan
Filter ini memungkinkan Anda mengaktifkan atau menonaktifkan halaman admin Blockstudio di bawah Tools > Blockstudio.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Aset
editor/canvas/body_class
Saat reset aset diaktifkan, filter ini menyesuaikan kelas body frontend yang telah disanitasi dan disalin ke kanvas editor blok.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
aktifkan
Filter ini memungkinkan Anda menonaktifkan pemrosesan dan pemuatan aset untuk jenis aset tertentu.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
nonaktifkan
Filter ini memungkinkan Anda menonaktifkan aset tertentu berdasarkan ID-nya. Aset yang cocok dengan ID dalam array yang dikembalikan tidak akan dirender di frontend.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
Filter ini memungkinkan Anda menambahkan path tambahan ke pernyataan @import pada compiler SCSS.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
Filter ini memungkinkan Anda menambahkan kode Sass bersama sebelum setiap file SCSS dikompilasi.
add_filter('blockstudio/assets/process/scss/prelude', function($prelude, $path, $scss) {
return '@import "functions";' . "\n"
. '@import "variables";' . "\n"
. '@import "mixins";';
}, 10, 3);
process/css/content
Filter ini memungkinkan Anda menyesuaikan konten file CSS sebelum dikompilasi.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
Filter ini memungkinkan Anda menyesuaikan konten file JS sebelum dikompilasi.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Buffer
diaktifkan
Blockstudio menyangga respons frontend agar tag gaya blok dan skrip yang dirender di dalam body dapat dipindahkan ke head dan footer, serta agar Tailwind dapat memindai seluruh dokumen. Buffering berarti menahan dan memindai seluruh dokumen pada setiap permintaan frontend; situs yang tidak merender aset blok Blockstudio dan tidak menggunakan Tailwind dapat mengembalikan false untuk melewati keduanya.
add_filter('blockstudio/buffer/enabled', '__return_false');
Buffering juga dinonaktifkan di admin dan pratinjau Customizer. Panggil bs_is_buffering() dari wp_enqueue_scripts atau setelahnya untuk mengetahui apakah respons saat ini di-buffer. Fungsi ini mengembalikan false sebelum keputusan dibuat di template_redirect.
output
Filter ini menerima dokumen HTML lengkap yang telah dibuffer sebelum dikirim. Proses pemindahan aset milik Blockstudio berjalan pada prioritas 1000000 dan kompilasi Tailwind pada 999999, jadi jalankan lebih awal untuk melihat dokumen sebelum proses tersebut atau lebih akhir untuk melihat output final.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Render
dependensi
Filter ini melaporkan templat dan dependensi aset yang dipilih setiap kali Blockstudio merender blok. Ini berguna untuk eksportir statis dan pengumpul dependensi dalam proses lainnya.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
global
Filter ini memungkinkan Anda menyesuaikan output halaman sebelum dirender.
add_filter('blockstudio/render', function($content) {
return $content;
});
head
Filter ini memungkinkan Anda menyesuaikan keluaran tag <head> sebelum dirender. Filter ini berjalan hanya saat Blockstudio melakukan buffering pada respons. Lihat bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
footer
Filter ini memungkinkan Anda menyesuaikan output </body> sebelum dirender.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Penanganan Error
error/logged
Aksi dijalankan setelah error dicatat. Gunakan ini untuk mengirim error ke layanan logging eksternal.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Aksi dijalankan setelah exception ditangani.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
Database
Semua hook database menerima satu array $params.
db/before_create
Aksi dijalankan sebelum rekaman dibuat.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Aksi dijalankan setelah rekaman dibuat.
add_action('blockstudio/db/after_create', function($params) {
// $params: block, schema, record, storage
wp_mail($params['record']['email'], 'Welcome!', 'Thanks for subscribing.');
});
db/before_update
Aksi dijalankan sebelum rekaman diperbarui.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Aksi dijalankan setelah rekaman diperbarui.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Aksi dijalankan sebelum rekaman dihapus.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Aksi dijalankan setelah rekaman dihapus.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Semua hook RPC menerima satu array $params.
rpc/before_call
Aksi dijalankan sebelum fungsi RPC dipanggil.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Aksi dijalankan setelah fungsi RPC dipanggil.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});