Lewati ke konten

Pendaftaran

Menyusun blok sendiri dengan Blockstudio sangat mudah. Plugin akan mencari folder blockstudio di dalam tema yang sedang diaktifkan. Semua subfolder di dalamnya yang berisi file block.json dengan kunci blockstudio akan didaftarkan.

block.json

JSON
{
  "name": "blockstudio/native",
  "title": "Native Block",
  "category": "text",
  "icon": "star-filled",
  "description": "Native Blockstudio block.",
  "blockstudio": true
}

Templat

Sejauh ini, blok khusus tersebut belum akan didaftarkan karena belum memiliki templat. Untuk memperbaikinya, buat index.php di folder yang sama dengan file block.json, lalu kontennya akan otomatis dirender saat blok digunakan.

PHP
<h1>My first native block.</h1>

Logika Kondisional

Blok dapat didaftarkan secara kondisional menggunakan kunci conditions. Kunci ini mendukung semua variabel global yang juga tersedia untuk atribut.

Lihat semua kondisi

Contoh berikut hanya akan mendaftarkan blok jika jenis pos saat ini adalah halaman:

JSON
{
  "blockstudio": {
    "conditions": [
      [
        {
          "type": "postType",
          "operator": "==",
          "value": "page"
        }
      ]
    ]
  }
}

Dependensi Plugin

Blok dapat bergantung pada plugin WordPress yang aktif menggunakan kunci pluginDependencies. Jika salah satu plugin yang tercantum tidak aktif, blok akan dilewati saat pendaftaran.

Dependensi menggunakan slug plugin WordPress:

JSON
{
  "blockstudio": {
    "pluginDependencies": [
      "woocommerce",
      "advanced-custom-fields"
    ]
  }
}

Gunakan bentuk objek untuk mewajibkan versi plugin. Batasan versi menggunakan operator yang sama seperti PHP pada version_compare(); versi tanpa operator dianggap sebagai >=.

JSON
{
  "blockstudio": {
    "pluginDependencies": {
      "woocommerce": {
        "version": ">6"
      }
    }
  }
}

Ikon Khusus

Ikon SVG khusus untuk blok dapat didaftarkan seperti ini:

JSON
{
  "blockstudio": {
    "icon": "<svg></svg>"
  }
}

WordPress tidak mengizinkan ikon SVG khusus di dalam kunci block.json icon miliknya sendiri; hanya ID Dashicons yang diizinkan di sini.

Blok WordPress Standar

Blockstudio juga otomatis mendaftarkan blok WordPress standar yang ditemukan di folder Blockstudio Anda. Setiap block.json tanpa kunci blockstudio tetapi dengan properti name yang valid didaftarkan melalui WordPress register_block_type() bawaan.

Artinya, Anda dapat menempatkan blok yang dibuat dengan @wordpress/create-block langsung ke dalam folder blockstudio/ dan blok tersebut akan didaftarkan otomatis bersama blok Blockstudio Anda. Tidak diperlukan kode pendaftaran plugin terpisah.

Kode
blockstudio/
├── hero/
│   ├── block.json          ← Blockstudio block (has "blockstudio" key)
│   └── index.twig
├── my-js-block/
│   ├── block.json          ← Standard WP block (no "blockstudio" key)
│   ├── index.js            ← Compiled editor script
│   ├── index.css
│   ├── style-index.css
│   └── render.php

Buat blok Anda dengan npx wp-scripts build, lalu letakkan folder hasilnya ke dalam direktori Blockstudio Anda. Blok akan didaftarkan secara otomatis.

Hal yang sama berlaku untuk blok yang hanya menggunakan PHP di WordPress 7.0: block.json dengan dukungan autoRegister dan sebuah render.php tidak memerlukan skrip maupun proses build, dan didaftarkan di sini seperti blok standar lainnya. Core membatasi jalur ini untuk blok sederhana dengan atribut string, integer, boolean, dan enum; begitu sebuah blok memerlukan blok bagian dalam, teks kaya, media, atau kontrol khusus, buat blok sisi klien atau berikan kunci blockstudio dan gunakan PHP.

HTML

Blockstudio menggunakan parser elemen React untuk merender elemen ikon, sehingga Anda dapat menggunakan HTML di dalam string ikon.

JSON
{
  "blockstudio": {
    "icon": "<div>:-)</div>"
  }
}

Jalur Khusus

Secara default, Blockstudio akan menelusuri folder blockstudio secara rekursif untuk mencari blok di dalam tema atau tema anak yang sedang digunakan. Anda dapat mengubah perilaku tersebut dengan dua cara.

Filter

PHP
// Custom path within your theme.
add_filter('blockstudio/path', function () {
    return get_template_directory() . '/blocks';
});

// Custom path within a plugin.
add_filter('blockstudio/path', function () {
    return WP_PLUGIN_DIR . '/my-custom-plugin/blocks';
});

Untuk sistem file gabungan atau virtual, gunakan sumber penemuan logis, alih-alih menambahkan jalur induk dan overlay secara terpisah. Sumber logis mendukung penimpaan per jalur, pewarisan file saudara, penghapusan, identitas cache, dan asal-usul. Lihat Sumber Penemuan Logis.

Instans

Jika opsi di atas tidak cukup, Anda dapat menginisiasi kelas Blockstudio\Build pada berbagai folder pilihan Anda:

PHP
add_action('init', function () {
  Blockstudio\Build::init([
    'dir' => get_template_directory() . '/client-blocks'
  ]);
});

Filter Metadata

Metadata dapat difilter sebelum blok didaftarkan menggunakan filter blockstudio/blocks/meta:

PHP
add_filter('blockstudio/blocks/meta', function ($meta, $block) {
    if (str_starts_with($block['name'], 'marketing')) {
        $meta['icon'] = 'megaphone';
    }
    return $meta;
}, 10, 2);

Contoh di atas digunakan secara internal agar semua elemen pustaka Blockstudio memiliki ikon yang sama.