Zapolnjevanje možnosti
Namesto uporabe različnih vrst polj, kot so objave, uporabniki ali izrazi, Blockstudio omogoča modularen način zapolnjevanja podatkov neposredno iz block.json. Ta funkcija deluje z vrstami polj select, radio, checkbox, color in gradient.
Podatke je mogoče zapolniti na štiri načine:
- Poizvedba – vrne rezultate poizvedbe za objave, uporabnike ali izraze
- Pridobivanje – vrne rezultate iz zunanjega vira
- Funkcija – vrne rezultate funkcije po meri
- Po meri – vrne rezultate nabora podatkov po meri
Poizvedba
Pri izbiri načina poizvedbe je mogoče zapolniti objave, uporabnike ali izraze.
{
"$schema": "https://blockstudio.dev/schema/block",
"name": "blockstudio/native",
"title": "Native Block",
"blockstudio": {
"attributes": [
{
"id": "posts",
"type": "select",
"label": "Posts",
"populate": {
"type": "query",
"query": "posts"
}
}
]
}
}
Razpoložljive vrste poizvedb interno uporabljajo te funkcije WordPress:
Argumenti
Argumente po meri lahko podate z atributom arguments:
{
"blockstudio": {
"attributes": [
{
"id": "posts",
"type": "select",
"label": "Posts",
"populate": {
"type": "query",
"query": "posts",
"arguments": {
"post_type": "jobs",
"numberposts": "20"
}
}
}
]
}
}
Oblika vrnjenih podatkov
Privzeto Blockstudio vrne:
| Poizvedba | Vrednost | Oznaka |
|---|---|---|
posts |
objekt objave | post_title |
users |
objekt uporabnika | display_name |
terms |
objekt izraza | name |
Prilagodite odgovor z možnostjo returnFormat:
{
"blockstudio": {
"attributes": [
{
"id": "posts",
"type": "select",
"label": "Posts",
"populate": {
"type": "query",
"query": "posts",
"arguments": {
"post_type": "posts",
"numberposts": "20"
},
"returnFormat": {
"value": "id",
"label": "post_name"
}
}
}
]
}
}
Način pridobivanja
Omogočite dinamično iskanje z možnostjo fetch:
{
"blockstudio": {
"attributes": [
{
"id": "posts",
"type": "select",
"label": "Posts",
"populate": {
"type": "query",
"query": "posts",
"fetch": true,
"arguments": {
"post_type": "posts",
"numberposts": "20"
}
}
}
]
}
}
S tem omogočite stylisedUi in sprva pridobite prvih 20 objav. Vnos v izbirno polje išče objave z argumentom s.
Funkcija
Uporabite funkcijo po meri za zapolnjevanje možnosti:
{
"blockstudio": {
"attributes": [
{
"id": "postTypes",
"type": "checkbox",
"label": "Post types",
"populate": {
"type": "function",
"function": "get_post_types"
}
}
]
}
}
Argumenti
Argumente podajte kot polje (interno uporablja call_user_func_array):
{
"blockstudio": {
"attributes": [
{
"id": "postTypes",
"type": "checkbox",
"label": "Post types",
"populate": {
"type": "function",
"function": "get_post_types",
"arguments": [[], "objects"]
}
}
]
}
}
Oblika vrnjenih podatkov
{
"blockstudio": {
"attributes": [
{
"id": "postTypes",
"type": "checkbox",
"label": "Post types",
"populate": {
"type": "function",
"function": "get_post_types",
"arguments": [[], "objects"],
"returnFormat": {
"value": "name",
"label": "label"
}
}
}
]
}
}
Kombiniranje možnosti
Združite statične možnosti s podatki, pridobljenimi dinamično:
{
"blockstudio": {
"attributes": [
{
"id": "users",
"type": "radio",
"label": "Users",
"options": [
{
"value": "administrators",
"label": "Administrators"
},
{
"value": "editors",
"label": "Editors"
}
],
"populate": {
"type": "query",
"query": "users",
"position": "before"
}
}
]
}
}
Možnost position (before ali after) določa, kje se pridobljene možnosti pojavijo glede na statične možnosti.
Opozorilo
Kombiniranje možnosti in pridobivanje podatkov ni podprto v načinu pridobivanja.
Podatki po meri
Ustvarite ponovno uporabne nabore podatkov s filtrom blockstudio/blocks/attributes/populate. Filter prejme en argument: polje vseh naborov podatkov po meri, indeksiranih po imenu. Dodajte svoj nabor pod ključ in vrnite polje:
add_filter('blockstudio/blocks/attributes/populate', function($options) {
$options['customData'] = [
['value' => '1', 'label' => 'Option 1'],
['value' => '2', 'label' => 'Option 2'],
];
return $options;
});
Nato se v bloku sklicujte na ključ:
{
"blockstudio": {
"attributes": [
{
"id": "posts",
"type": "select",
"label": "Posts",
"populate": {
"type": "custom",
"custom": "customData"
}
}
]
}
}
Zunanji podatki
Pridobite podatke iz zunanjega vira:
{
"blockstudio": {
"attributes": [
{
"id": "select",
"type": "select",
"label": "Select",
"multiple": true,
"populate": {
"type": "fetch",
"arguments": {
"urlSearch": "https://example.com/wp-json/wp/v2/posts?search="
},
"returnFormat": {
"value": "id",
"label": "title.rendered"
}
}
}
]
}
}
Iskalni izraz je dodan na konec urlSearch.
Dinamični argumenti
Argumenti za zapolnjevanje se lahko z zapisom {attributes.*} sklicujejo na druge atribute bloka. Ko se sklicevani atribut spremeni, polje samodejno znova pridobi svoje možnosti.
{
"blockstudio": {
"attributes": [
{
"id": "post_type",
"type": "select",
"label": "Post Type",
"options": [
{ "label": "Pages", "value": "page" },
{ "label": "Posts", "value": "post" }
]
},
{
"id": "selected_post",
"type": "select",
"label": "Select Post",
"populate": {
"type": "query",
"query": "posts",
"arguments": {
"post_type": "{attributes.post_type.value}",
"numberposts": 10
}
}
}
]
}
}
To deluje pri vseh vrstah zapolnjevanja (query, function, custom). Vsaka vrednost v konfiguraciji za zapolnjevanje, ki vsebuje {attributes.*}, se pred izvedbo poizvedbe razreši na strani odjemalca z uporabo trenutne vrednosti atributa.
Reference uporabljajo shranjene vrednosti iz urejevalnika. Pri možnosti spustnega seznama uporabite {attributes.post_type.value} za njeno vrednost ali {attributes.post_type.label} za njeno oznako; returnFormat določa vrednost predloge, ne pa te shranjene oblike iz urejevalnika.
Vgnezdeni argumenti se razrešijo, ne da bi se serializirali v niz predloge.
Argument, sestavljen iz enega nadomestnega mesta, ohrani svoj tip, vključno s števili, logičnimi vrednostmi, polji in objekti. Nadomestno mesto, vstavljeno v drugo besedilo, ustvari niz. Manjkajoče reference ostanejo nespremenjene, narekovane vrednosti in vrednosti v več vrsticah pa se posredujejo nespremenjene.
Povratne funkcije ohranijo svoje sezname pozicijskih argumentov. Urejevalnik doda argumente za iskanje WordPress samo funkcijam populate query, ne pa klicem funkcij.
Izris odvisnih izbir
Odvisne možnosti se ne naložijo ob registraciji bloka, saj ima lahko vsak primerek bloka drugačne argumente. Pri izrisu se uporabi shranjena izbira, namesto da bi jo zavrgli zaradi praznega seznama možnosti. Povratna funkcija populate se znova ne izvede na sprednjem delu spletnega mesta.
Velja tudi polje returnFormat:
returnFormat |
Enojni izbor | Večkratni izbor |
|---|---|---|
value (privzeto) |
Shranjena vrednost, na primer "a" |
Polje shranjenih vrednosti, na primer ["a", "b"] |
label |
Shranjena oznaka | Polje shranjenih oznak |
both |
Shranjena možnost {value, label} |
Polje shranjenih možnosti |
Pri izbirah, napolnjenih s poizvedbo, se vrednosti še vedno razrešijo v ustrezni objekt objave, uporabnika ali izraza WordPress, razen če je populate.returnFormat.value "id". Oznake izvirajo iz shranjene izbire. Če uvožena izbira nima oznake, se kot oznaka uporabi njena vrednost. Ujemajoča se statična možnost, deklarirana v options, ima prednost pred shranjeno možnostjo, zato se uporabi njena trenutna oznaka.
Prazne izbire ostanejo false (ali nastavljena vrednost polja fallback). To ne spremeni preverjanja običajnih statičnih možnosti: shranjena vrednost, ki je ni več na seznamu statičnih možnosti, še vedno vrne false.
Tudi dinamični izbirniki ohranijo izbire default in fallback, medtem ko so njihove možnosti odložene. Za večkratni izbor uporabite skalarno vrednost, možnost {value, label} ali polje enega ali drugega. Skalar uporabi svojo vrednost kot oznako, razen če se ujema z deklarirano statično možnostjo. Objekt možnosti ohrani podano oznako; ujemajoča se statična možnost ima prednost. Na strežniku se za iskanje teh privzetih vrednosti ne izvede nobena funkcija povratnega klica populate.