Lewati ke konten

Memulai

Panduan ini akan membantu Anda menyiapkan Blockstudio dan membuat blok kustom pertama Anda.

Instalasi

Shell
composer require blockstudio/blockstudio

Blockstudio dapat dipasang sebagai plugin melalui composer/installers atau disertakan langsung di dalam tema. Lihat dokumentasi Composer untuk semua metode pemasangan.

Instalasi Composer menerima pembaruan melalui Composer. Pembaru GitHub bawaan akan otomatis dinonaktifkan.

Instalasi Manual

Unduh rilis terbaru dari GitHub

Unggah file zip ke direktori plugin WordPress Anda, lalu aktifkan plugin tersebut. Instalasi manual menerima notifikasi pembaruan otomatis di dasbor WordPress melalui pembaru GitHub bawaan.

Kedua metode instalasi menyertakan salinan privat pustaka Markdown, YAML, dan updater beserta dependensinya. Metode ini tidak menggunakan atau mengganti versi yang disediakan plugin atau tema lain. Instal dependensi Composer Anda sendiri jika aplikasi Anda menggunakan salah satu pustaka tersebut secara langsung; salinan bawaan Blockstudio bersifat internal, bukan PHP API publik.

Pemeriksaan Pembaruan Terautentikasi

Secara default, instalasi manual memeriksa GitHub secara anonim. Beberapa situs yang berbagi satu IP keluar dapat menghabiskan kuota anonim GitHub untuk API dan menerima respons HTTP 403 saat memeriksa pembaruan. Dari 7.7.4, konfigurasikan token akses pribadi GitHub di wp-config.php, sebelum WordPress dimuat:

PHP
define('BLOCKSTUDIO_GITHUB_TOKEN', 'your-github-token');

Token hanya memerlukan akses ke informasi repositori publik. Jangan berikan izin tulis. Simpan token dalam konfigurasi sisi server, di luar kontrol versi, blockstudio.json, atribut blok, dan kode frontend. Updater meneruskannya ke klien GitHub bawaannya untuk pemeriksaan terautentikasi dan pengunduhan rilis. Permintaan ke repositori yang tidak terkait dan host unduhan lain tidak menerima token tersebut.

Untuk rahasia yang dikelola lingkungan, plugin MU dapat menyediakan atau mengganti token:

PHP
<?php
add_filter('blockstudio/updater/token', function ($token) {
  return getenv('BLOCKSTUDIO_GITHUB_TOKEN') ?: $token;
});

Filter berjalan saat Blockstudio menginisialisasi updater-nya, sebelum tema dimuat. Daftarkan di plugin MU, bukan functions.php. Mengembalikan string kosong akan menonaktifkan autentikasi meskipun konstanta telah ditetapkan. Nilai kosong atau non-string membuat pemeriksaan tetap anonim. Token bersifat opsional; tanpa token, perilaku pembaruan yang ada tidak berubah. Instalasi Composer tetap menggunakan Composer untuk pembaruan dan tidak menginisialisasi updater ini.

Membuat Blok Pertama Anda

1. Buat Direktori Blok

Buat direktori baru di tema Anda:

Kode
my-theme/
  blockstudio/
    my-first-block/
      block.json
      index.php

2. Tentukan Skema Blok

Buat block.json dengan konfigurasi blok Anda:

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "my-theme/my-first-block",
  "title": "My First Block",
  "category": "common",
  "icon": "star-filled",
  "blockstudio": {
    "attributes": [
      {
        "id": "heading",
        "type": "text",
        "label": "Heading",
        "default": "Hello World"
      },
      {
        "id": "content",
        "type": "textarea",
        "label": "Content"
      }
    ]
  }
}

3. Buat Templat

Buat index.php untuk perenderan:

PHP
<div class="my-first-block">
  <h2><?php echo $a['heading']; ?></h2>
  <p><?php echo $a['content']; ?></p>
</div>

Menggunakan Templat Twig

Blockstudio mendukung templat Twig secara bawaan. Cukup gunakan index.twig:

Twig
<div class="my-first-block">
  <h2>{{ a.heading }}</h2>
  <p>{{ a.content }}</p>
</div>

Menambahkan Gaya

Buat file style.css di folder yang sama:

CSS
.my-first-block {
  padding: 2rem;
  background: #f5f5f5;
}

Blockstudio akan otomatis memasukkan stylesheet ini ke antrean saat blok digunakan.

Terjemahan

Kontrol editor dan ringkasan admin milik Blockstudio memuat terjemahan JavaScript untuk domain teks blockstudio melalui WordPress. Pasang paket bahasa yang sesuai atau buat file terjemahan skrip JSON dengan alat terjemahan Anda di wp-content/languages/plugins/. String yang terjemahannya tidak tersedia akan tetap dalam bahasa Inggris. Ini menerjemahkan antarmuka Blockstudio sendiri, bukan konten atau label field yang Anda tentukan di blok.

Langkah Berikutnya

Blok Anda kini siap digunakan di editor WordPress. Lanjutkan menjelajahi dokumentasi untuk mempelajari:

Membangun Pustaka Blok

Kembangkan satu blok menjadi pustaka lengkap: token desain, pola bagian, repeater, gambar, dan penyusunan halaman.