Uzantılar
Uzantılar, WordPress kurulumunuzdaki kayıtlı tüm blokları, block.json yapılandırmasına benzeyen, .json tabanlı basit bir API kullanarak genişletmenizi sağlar. Buna temel bloklar, üçüncü taraf bloklar ve Blockstudio ile oluşturulan bloklar dahildir.
Tüm alan türleri herhangi bir bloğa eklenebilir ve veriler bloğun özniteliklerine kaydedilir. filtreleme, devre dışı bırakma, koşullu mantık ve seçenekleri doldurma gibi özniteliklerin tüm özellikleri uzantılarda kullanılabilir.
Uzantı Türleri
Genişletilmiş değerler çok çeşitli şekillerde kullanılabilir:
- class: Öznitelik değerini kullanarak bloğa bir sınıf ekleyin
- style: Öznitelik değerini kullanarak bloğa satır içi stiller ekleyin
- attributes: Herhangi bir öznitelik değerini doğrudan blokta ayarlayın
- data attributes: Belirli data özniteliklerini ayarlamak için uzantı değerlerini kullanın
Kurulum
Şöyle bir senaryo düşünün: her çekirdek bloğa özel bir sınıf select alanı eklemek istiyorsunuz. Tek yapmanız gereken bu .json dosyasını blok klasörünüzün herhangi bir yerine eklemek; dosya otomatik olarak bir uzantı şeklinde kaydedilir.
{
"$schema": "https://blockstudio.dev/schema/extend",
"name": "core/*",
"priority": 10,
"blockstudio": {
"extend": true,
"attributes": [
{
"id": "customColor",
"type": "select",
"label": "Custom color",
"options": [
{
"value": "#f00",
"label": "Red"
},
{
"value": "#00f",
"label": "Blue"
}
],
"set": [
{
"attribute": "style",
"value": "color: {attributes.customColor}"
}
]
}
]
}
}
Bu, her çekirdek bloğa bir customColor alanı ekleyerek blok metninin rengini ayarlamanızı sağlar.
Dosya Adı
Bir görüntüleme şablonu olmadığı için uzantının eşleşen bir index dosyasına ihtiyacı yoktur ve bu nedenle adının block.json olması da gerekmez. Böylece tüm uzantıları tek bir klasörde kolayca saklayabilirsiniz. Örneğin "name": "core/*" içeren iki dosya gibi birden fazla dosya aynı blokları genişletebilir; her biri kendi alanlarını kaydeder.
Şema
Blockstudio, uzantı yapılandırmaları için özel bir JSON şeması sunar:
Ad
Yapılandırma nesnesindeki name özelliği, hangi blokların genişletileceğini belirler. İhtiyacınıza göre üç seçenek vardır:
- blockName: Tek bir blok adı, e.g.
core/paragraph - [blockNameA, blockNameB]: Blok adlarından oluşan bir dizi, e.g.
["core/paragraph", "core/heading"] - core/*: Belirli bir türdeki tüm blokları genişletmek için joker karakter
Yıldız işaretiyle biten her ad, yalnızca core/* için değil, bir önek joker karakteridir. Aşağıdaki uzantı, adı my-plugin/ ile başlayan ve Blockstudio ile oluşturulanlar da dahil olmak üzere tüm bloklara uygulanır:
{
"name": "my-plugin/*",
"blockstudio": {
"extend": true,
"attributes": []
}
}
Blokları Hariç Tutma
Aksi halde name ile eşleşecek blokları atlamak için üst düzey bir exclude dizisi kullanın:
{
"$schema": "https://blockstudio.dev/schema/extend",
"name": "core/*",
"exclude": ["core/button", "core/image"],
"blockstudio": {
"extend": true,
"attributes": []
}
}
Hariç tutmalar, name ile aynı tam ad ve sondaki * önek eşleştirmesini kullanır.
Tek adlara, ad listelerine ve joker karakterlere göre önceliklidir. Hariç tutulan
bir blok, uzantının düzenleyici alanlarını, ön yüz özniteliklerini veya varlıklarını almaz.
Eşleşen diğer uzantılar etkilenmez. Mevcut davranışı korumak için exclude öğesini
atlayın veya boş bir dizi kullanın.
Blockstudio Anahtarı
Özel bloklarda block.json kullanırken olduğu gibi, yapılandırma nesnesinde blockstudio özelliği bulunmalı ve extend değeri true olarak ayarlanmalıdır.
Konum
Uzantılar varsayılan olarak blok denetçisinde kendi sekmelerinde görüntülenir. Uzantıları başka bir konuma taşımak için group özelliğini kullanabilirsiniz:
- settings: Varsayılan konum
- styles: Stiller sekmesi
- advanced: Gelişmiş sekmesi
{
"$schema": "https://blockstudio.dev/schema/extend",
"name": "core/*",
"blockstudio": {
"extend": true,
"group": "styles",
"attributes": []
}
}
Öncelik
priority özelliği, uzantıların görüntülenme sırasını belirlemenizi sağlar. Daha yüksek önceliğe sahip uzantılar daha sonra görüntülenir. Bunu kurulum örneğindeki gibi dosyanın en üst düzeyinde veya extend içinde ayarlayın:
{
"$schema": "https://blockstudio.dev/schema/extend",
"name": "core/*",
"blockstudio": {
"extend": { "priority": 10 },
"attributes": []
}
}
İkisi de ayarlanmışsa blockstudio.extend.priority önceliklidir.
Öznitelikler
Özniteliklerin çalışma şekli hakkında daha fazla bilgi için lütfen öznitelikler bölümüne bakın.
Uzantılardaki öznitelikler hakkında bilmeniz gereken tek şey set özelliğidir. Bu özellik, özniteliğin değerini uzantı türlerinden birine uygulamak için kullanılır.
{
"$schema": "https://blockstudio.dev/schema/extend",
"name": "core/*",
"blockstudio": {
"extend": true,
"attributes": [
{
"id": "customColor",
"type": "select",
"label": "Heading color",
"options": [
{
"value": "#f00",
"label": "Red"
},
{
"value": "#00f",
"label": "Blue"
}
],
"set": [
{
"attribute": "style",
"value": "color: {attributes.customColor}"
}
]
}
]
}
}
Değerleri Alma
Bir özniteliğin değerini almak için küme parantezleri içinde nokta gösterimi kullanılır.
Öznitelikler tek bir değer döndürmediğinde de iç içe değerler alınabilir; örneğin seçenekleri olan alan türlerinde dönüş biçimi both olarak ayarlandığında.
{
"attributes": [
{
"id": "customColor",
"type": "select",
"label": "Heading color",
"options": [
{
"value": "#f00",
"label": "Red"
},
{
"value": "#00f",
"label": "Blue"
}
],
"returnFormat": "both",
"set": [
{
"attribute": "style",
"value": "color: {attributes.customColor.value}"
},
{
"attribute": "data-color",
"value": "{attributes.customColor.label}"
}
]
}
]
}
Yukarıdaki örnek, değere bağlı olarak style özniteliğini color: #f00 veya color: #00f, data-color özniteliğini ise Red veya Blue olarak ayarlar.
Şimdilik set tanımlarında yalnızca mevcut öznitelikteki değerler kullanılabilir. Gelecekte diğer özniteliklerdeki değerleri kullanma desteği eklenebilir.
Diziler
Diziler kullanıldığında set özelliği dizideki her öğeye uygulanır.
Her öğe kendi sınıfını veya stil bildirimini ekler. Diğer tüm öznitelikler tek bir değer tutar; bu nedenle her öğe öncekinin üzerine yazar ve son öğe geçerli olur. Bunun yerine tüm öğelerin sonuçlarını boş veya yinelenen değerler olmadan, boşluklarla ayırarak yazmak için join değerini true olarak ayarlayın; böylece [data-langs~="en"] gibi bir seçici seçilen her öğeyle eşleşir. join, class ve style üzerinde ya da tek bir değer döndüren alanlarda etkili değildir.
{
"id": "langs",
"type": "checkbox",
"label": "Languages",
"options": [
{
"value": "en",
"label": "English"
},
{
"value": "de",
"label": "German"
}
],
"set": [
{
"attribute": "data-langs",
"value": "{attributes.langs}",
"join": true
}
]
}
Her iki seçenek de seçildiğinde data-langs="en de" oluşturulur. join olmadan data-langs="de" oluşturulur.
Öznitelikler Alanı
attributes alanı kullanıldığında set özelliğine gerek yoktur; alan, değerleri öznitelik adı ve değeriyle otomatik olarak eşleştirir.
Uzantı Alanlarını İnceleme
bs_block_extension_fields('core/paragraph'), bir blokla eşleşen her uzantının alan tanımlarını döndürür. Döndürülen değer ve bs_block_fields() ile ilişkisi için Blokları İnceleme bölümüne bakın.