Lewati ke konten

Blok kustom dalam 3 berkas

Tanpa JavaScript, tanpa langkah build, tanpa boilerplate.

Definisikan field di JSON

Tambahkan kunci blockstudio ke block.json. Tentukan atribut dengan tipe seperti text, toggle, dan color. Blockstudio membuat UI editor secara otomatis, dengan tipe bidang 27 mulai dari input teks hingga repeater dan editor kode, serta tipe bidang yang Anda daftarkan sendiri.

Dukungan skema JSON penuh menyediakan pelengkapan otomatis dan validasi di VS Code, PhpStorm, dan setiap editor yang kompatibel.

Setiap field dapat menetapkan default untuk blok baru dan fallback yang diterima templat saat field kosong.

block.json
{
  "name": "starter/hero",
  "title": "Hero",
  "blockstudio": {
    "attributes": [
      { "id": "heading", "type": "text", "label": "Heading" },
      { "id": "showCta", "type": "toggle", "label": "Show CTA" },
      { "id": "background", "type": "color", "label": "Background" }
    ]
  }
}

Alur kerja 3 file

block.json untuk field, template untuk markup, dan stylesheet opsional.

React di PHP

RichText, InnerBlocks, dan useBlockProps langsung berfungsi di PHP, Twig, atau Blade.

SCSS dan Tailwind

Gunakan CSS, SCSS, atau Tailwind. SCSS mendukung jalur impor dan prelude bersama, dan pengeditan partial bertingkat akan mengompilasi ulang setiap file yang mengimpornya.

27 jenis field

Teks, warna, gambar, repeater, pilihan, editor kode, dan lainnya, dikonfigurasi di JSON.

JSON Schema

Pelengkapan otomatis dan validasi di VS Code, PhpStorm, dan editor yang kompatibel.

Tiga bahasa template

PHP, Twig, dan Blade menggunakan variabel dan komponen yang sama.

Impor npm

Impor paket di script.js; paket disimpan secara lokal di produksi dan didukung CDN di editor.

Interactivity API

Aktifkan Interaktivitas WordPress API dengan satu flag.

Komponen React dalam template PHP

Gunakan <RichText /> untuk pengeditan inline dan HTML frontend statis, <InnerBlocks /> untuk blok anak, dan useBlockProps untuk pembungkus, semuanya dalam satu template.

Di editor, semua ini menjadi komponen React sungguhan. Di frontend, semuanya dirender sebagai HTML sisi server, tanpa JavaScript yang dikirim ke pengunjung.

index.php
<div useBlockProps class="container">
  <RichText
    class="text-xl font-semibold"
    tag="h1"
    attribute="headline"
    placeholder="Enter headline"
  />

  <?php if ($a['showCta']): ?>
    <a href="<?= esc_url($a['ctaUrl']) ?>">
      <?= esc_html($a['ctaLabel']) ?>
    </a>
  <?php endif; ?>

  <InnerBlocks class="mt-4 p-4 border" />
</div>

Menulis dengan PHP, Twig, atau Blade

Gunakan bahasa templat yang Anda kuasai. PHP langsung tersedia, Twig berjalan setelah Timber diinstal, dan Blade berjalan pada illuminate/view 8 hingga 12 melalui Blockstudio\Blade_Renderer. Variabel, komponen, dan perilakunya tetap sama.

$a (atribut), $b (blok), $c (konteks), dan $innerBlocks tersedia dalam setiap bahasa.

Twig template juga menerima konteks Timber secara lengkap. Blade juga merender halaman, pola, dan template Site Editor. Wrapper jenssegers/blade yang lama gagal pada illuminate/view 10 dan versi lebih baru, jadi gunakan Blade_Renderer sebagai gantinya.

index.twig
<div useBlockProps class="card">
  <RichText tag="h2" attribute="title" placeholder="Card title" />
  {% if a.image %}
    <img src="{{ a.image.url|esc_url }}"
      alt="{{ a.image.alt|esc_attr }}" />
  {% endif %}
  <div class="card__body">{{ a.description|esc_html }}</div>
  <InnerBlocks allowedBlocks='["core/button"]' />
</div>

Logika kondisional dan opsi dinamis

Tampilkan dan sembunyikan field menggunakan operator seperti ==, !=, includes, empty, dan perbandingan. Gabungkan kondisi dengan logika OR.

Opsi dapat bergantung pada kolom lain. Masukkan {attributes.post_type.value} ke dalam argumen populate, lalu daftar akan dimuat ulang saat kolom tersebut berubah. Tambahkan fetch: true untuk mencari postingan saat editor mengetik.

Bagikan satu daftar opsi ke berbagai blok dengan type: custom dan filter blockstudio/blocks/attributes/populate, lalu daftarkan kondisi global Anda sendiri, seperti pemeriksaan pembelian, melalui blockstudio/blocks/conditions.

block.json
{
  "name": "starter/posts",
  "title": "Posts",
  "blockstudio": {
    "attributes": [
      {
        "id": "post_type",
        "type": "select",
        "label": "Post type",
        "options": [
          { "value": "page", "label": "Pages" },
          { "value": "post", "label": "Posts" }
        ]
      },
      {
        "id": "selected_post",
        "type": "select",
        "label": "Post",
        "populate": {
          "type": "query",
          "query": "posts",
          "arguments": { "post_type": "{attributes.post_type.value}" }
        }
      },
      {
        "id": "style",
        "type": "select",
        "label": "Style",
        "populate": { "type": "custom", "custom": "cardStyles" },
        "conditions": [[
          { "type": "purchasedProduct", "operator": "==", "value": "yes" }
        ]]
      }
    ]
  }
}

Repeater yang tetap mudah dikelola

Atur min dan max, mulai blok baru dengan default baris, lalu ciutkan baris yang ada dengan minimized. textMinimized memberi label pada baris yang diciutkan menggunakan salah satu kolomnya sendiri, seperti nama.

Baris menerima semua jenis kolom kecuali tab, termasuk repeater bertingkat. Kondisi di dalam baris memeriksa kolom di luarnya dengan "context": "main", sedangkan <RichText /> dan <MediaPlaceholder /> mengedit satu baris saat attribute-nya mengarah ke repeaterId[index].fieldId.

block.json
{
  "name": "starter/team",
  "title": "Team",
  "blockstudio": {
    "attributes": [
      {
        "id": "members",
        "type": "repeater",
        "label": "Team members",
        "min": 1,
        "max": 12,
        "minimized": true,
        "textMinimized": { "id": "name", "fallback": "Team member" },
        "attributes": [
          { "id": "name", "type": "text", "label": "Name" },
          { "id": "bio", "type": "richtext", "label": "Bio" }
        ]
      }
    ]
  }
}

Kumpulan kolom yang dapat digunakan kembali

Tentukan grup kolom sekali dalam field.json, lalu rujuk dari blok mana pun dengan "type": "custom/cta". Kolom disertakan langsung, sehingga template membacanya seperti atribut lainnya.

Gunakan kumpulan yang sama dua kali dengan idStructure seperti hero_{id}, lalu ubah label, nilai default, atau kondisi per blok dengan overrides. Jenis kolom block melakukan hal yang sama untuk satu blok utuh: jenis ini menyertakan kolom blok tersebut secara langsung dan mengembalikan HTML hasil render-nya.

fields/cta/field.json
{
  "name": "cta",
  "title": "Call to action",
  "attributes": [
    { "id": "label", "type": "text", "label": "Button label", "default": "Learn more" },
    { "id": "url", "type": "link", "label": "Button URL" }
  ]
}

Modul ES tanpa langkah build

Tambahkan script.js dan file tersebut akan dimuat sebagai modul ES. Impor paket npm dengan awalan npm: dan Blockstudio mengunduhnya secara lokal untuk produksi.

Editor mendapatkan pratinjau instan, sementara frontend menggunakan modul lokal tanpa dependensi eksternal, yang dimasukkan ke antrean hanya sekali.

Stylesheet diimpor dengan cara yang sama. import "npm:swiper@11.0.0/swiper.min.css" mengunduh file dan memasukkannya ke antrean satu kali untuk setiap versi, bahkan saat beberapa blok menggunakannya.

script.js
import Swiper from "npm:swiper@11.0.0";
import "npm:swiper@11.0.0/swiper.min.css";

for (const el of document.querySelectorAll(".swiper")) {
  new Swiper(el, {
    slidesPerView: 3,
    spaceBetween: 20,
    loop: true,
  });
}

Tag blok di luar template

Petakan prefiks pendek ke namespace di blockstudio.json, atau satu tag ke satu blok dengan filter alias, lalu <acme-card> merender acme/card. Aktifkan blockTags.enabled untuk merender tag dalam konten postingan dan widget, dengan batasan pola allow dan deny.

Atribut data-* diteruskan ke elemen akar blok, sedangkan atribut html-* tiba di sana tanpa prefiks. Tambahkan pembuat tag Anda sendiri dengan blockstudio/block_tags/builders, lalu ubah bentuk singkat menjadi format <bs:acme-card> yang portabel dengan perintah migrate-block-tags.

blockstudio.json
{
  "blockTags": {
    "enabled": true,
    "prefixes": {
      "acme": ["acme"],
      "ui": ["acme-ui"]
    },
    "deny": ["acme-ui/admin-*"]
  }
}

Tipe field kustom

Daftarkan kontrol field sendiri dan gunakan seperti field bawaan.

Blok pulau

Cache seluruh halaman dan render satu blok dalam permintaan pengunjung.

Pendaftaran bersyarat

Daftarkan blok hanya untuk jenis postingan, peran pengguna, atau kondisi global lainnya, atau lewati pendaftarannya jika plugin yang dibutuhkan atau versi pluginnya tidak tersedia.

Meta pos dan opsi

Simpan nilai di meta pos atau opsi bersama atribut blok.

Logika kondisional

Tampilkan field berdasarkan nilai dengan menggunakan kesetaraan, keanggotaan, kondisi kosong, dan perbandingan.

Pengisian dinamis

Isi pilihan dari pos, pengguna, term, fungsi, atau API.

Penimpaan

Atur override: true dengan nama blok bersama untuk menggabungkan atribut berdasarkan id, mengganti aset dengan nama file yang cocok, dan menukar template. Template Twig dapat menimpa satu blok dengan extends.

Variasi

Deklarasikan variasi di block.json untuk menetapkan nilai awal kolom, lalu sembunyikan kolom pengendalinya dengan hidden.

Komponen

Atur component: true untuk blok yang hanya merender konten dari PHP atau tag blok. Blok ini tetap memiliki kolom, template, aset, dan Tailwind, tetapi tidak pernah muncul di penyisip.

Aturan InnerBlocks

Izinkan blok dengan token namespace/*, category:, dan @theme, alihkan template dalam dari opsi select, lalu hilangkan pembungkus di frontend dengan filter.

Aset kolom kode

Kolom kode dengan asset: true mengubah input editor menjadi CSS, SCSS, atau JavaScript untuk blok tersebut, yang dibatasi ke instance melalui %selector%.

Aset berdasarkan nama file

*.view.js hanya dimuat di frontend, sedangkan prefiks global-, admin-, dan block-editor- memuat file di setiap halaman, di wp-admin, atau di editor blok.

Ikon dan folder blok

Beri blok ikon SVG kustom atau ikon HTML, ubah lokasi pencarian dengan filter blockstudio/path, dan tambahkan folder dengan Blockstudio\Build::init().

Nilai ACF dan Meta Box

Template menerima $post_id, sehingga get_field() dan rwmb_get_value() membaca postingan yang telah diedit, dan refreshOn memuat ulang pratinjau setelah penyimpanan.

Konteks Query Loop

Di dalam Query Loop, $block[‘context’][‘postId’] mengikuti item saat ini, sedangkan $block[‘postId’] tetap merujuk pada postingan yang sedang dilihat.

WPML

wp bs wpml config menulis wpml-config.xml yang menandai kolom teks agar dapat diterjemahkan, dan gambar yang disimpan di kolom ikut dalam pekerjaan terjemahan WPML bersama teks alternatif dan keterangannya.

Plus

Kit ekstensi resmi

Template situs premium, instruksi sistem AI, dan komunitas Discord privat. Pembelian satu kali, pembaruan seumur hidup.

  • 500+ templat situs
  • Instruksi sistem AI
  • Pembaruan seumur hidup
  • Komunitas privat Discord