İçeriğe geç

Kayıt

Blockstudio ile kendi bloklarınızı oluşturmak çok kolaydır. Eklenti, etkin temanıza ait blockstudio klasörünü arar. İçinde blockstudio anahtarına sahip bir block.json dosyası bulunan tüm alt klasörler kaydedilir.

block.json

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

Şablon

Şu ana kadar özel blok kaydedilmez; çünkü bir şablonu eksiktir. Bunu düzeltmek için block.json dosyanızla aynı klasörde bir index.php oluşturun; içerikleri blok kullanıldığında otomatik olarak oluşturulur.

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

Koşullu mantık

Bloklar, conditions anahtarı kullanılarak koşullu biçimde kaydedilebilir. Bu anahtar, öznitelikler için de kullanılabilen tüm genel değişkenleri destekler.

Tüm koşulları görün

Aşağıdaki örnekte blok yalnızca mevcut yazı türü bir sayfaysa kaydedilir:

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

Eklenti bağımlılıkları

Bloklar, etkin WordPress eklentilerine pluginDependencies anahtarını kullanarak bağımlı olabilir. Listelenen eklentilerden biri etkin değilse blok kayıt sırasında atlanır.

Bağımlılıklarda WordPress eklenti kısa adları kullanılır:

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

Eklenti sürümü gerektirmek için nesne biçimini kullanın. Sürüm kısıtları PHP version_compare() ile aynı işleçleri kullanır; işleç belirtilmeyen bir sürüm >= olarak değerlendirilir.

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

Özel simge

Bloklar için özel SVG simgeleri şu şekilde kaydedilebilir:

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

WordPress, kendi block.json icon anahtarı içinde özel SVG simgelerine izin vermez; burada yalnızca Dashicon’larının kimlikleri kullanılabilir.

Standart WordPress Blokları

Blockstudio, Blockstudio dizinlerinizde bulunan standart WordPress bloklarını da otomatik kaydeder. blockstudio anahtarı olmayan, ancak geçerli bir name özelliği bulunan her block.json, WordPress yerel register_block_type() API’si üzerinden kaydedilir.

Bu, @wordpress/create-block ile iskeleti oluşturulan blokları doğrudan blockstudio/ klasörünüze yerleştirebileceğiniz ve bunların Blockstudio bloklarınızla birlikte otomatik kaydedileceği anlamına gelir. Ayrı bir eklenti kayıt kodu gerekmez.

Kod
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

Bloğunuzu npx wp-scripts build ile oluşturun, ardından çıktı klasörünü Blockstudio dizininize taşıyın. Otomatik olarak kaydedilir.

Aynı durum WordPress 7.0 sürümünün PHP tabanlı blokları için de geçerlidir: autoRegister desteğine sahip bir block.json ve bir render.php betik ya da derleme gerektirmez ve burada diğer tüm standart bloklar gibi kaydedilir. Çekirdek, bu yolu dize, tam sayı, boole ve enum özniteliklerine sahip basit bloklarla sınırlar; iç bloklar, zengin metin, medya veya özel denetimler gerektiğinde istemci tarafında bir blok oluşturun ya da bir blockstudio anahtarı ekleyerek PHP içinde kalın.

HTML

Blockstudio, simge öğesini oluşturmak için React öğe ayrıştırıcısını kullanır; bu nedenle simge dizesinde HTML kullanmak mümkündür.

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

Özel yollar

Varsayılan olarak Blockstudio, blokları bulmak için geçerli temanızdaki veya alt temanızdaki blockstudio klasörünü özyinelemeli olarak tarar. Bu davranışı iki şekilde değiştirebilirsiniz.

Filtre

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';
});

Birleştirilmiş veya sanal dosya sistemleri için bağımsız üst ve katman yolları eklemek yerine mantıksal bir keşif kaynağı kullanın. Mantıksal kaynaklar yol bazında gölgeleme, devralınan kardeş dosyalar, silmeler, önbellek kimliği ve kaynak bilgisini destekler. Bkz. Mantıksal Keşif Kaynakları.

Örnekler

Yukarıdaki seçenekler yeterli değilse Blockstudio\Build sınıfını seçtiğiniz çeşitli klasörlerde başlatabilirsiniz:

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

Meta verileri filtreleme

Blok kaydedilmeden önce meta veriler blockstudio/blocks/meta filtresiyle filtrelenebilir:

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

Yukarıdaki örnek, tüm Blockstudio kitaplık öğelerine aynı simgeyi vermek için dahili olarak kullanılır.