Pāriet uz saturu

Opciju aizpildīšana

Tā vietā, lai piedāvātu dažādus lauku tipus, piemēram, Posts, Users vai Terms, Blockstudio ļauj modulārā veidā aizpildīt datus tieši no block.json. Šī funkcija darbojas ar lauku tipiem select, radio, checkbox, color un gradient.

Datus var aizpildīt četros veidos:

  • Vaicājums – Atgriež ierakstus no ziņu, lietotāju vai terminu vaicājuma
  • Ielāde – Atgriež ierakstus no ārēja avota
  • Funkcija – Atgriež ierakstus no pielāgotas funkcijas
  • Pielāgoti dati – Atgriež ierakstus no pielāgotas datu kopas

Vaicājums

Izvēloties vaicājuma režīmu, var aizpildīt Posts, Users vai Terms.

JSON
{
  "$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"
        }
      }
    ]
  }
}

Pieejamie vaicājumu veidi iekšēji izmanto šīs WordPress funkcijas:

Vaicājums Funkcija
posts get_posts
users get_users
terms get_terms

Argumenti

Pielāgotus argumentus var nodot, izmantojot atribūtu arguments:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "posts",
        "type": "select",
        "label": "Posts",
        "populate": {
          "type": "query",
          "query": "posts",
          "arguments": {
            "post_type": "jobs",
            "numberposts": "20"
          }
        }
      }
    ]
  }
}

Atgriešanas formāts

Pēc noklusējuma Blockstudio atgriež:

Vaicājums Vērtība Etiķete
posts ziņas objekts post_title
users lietotāja objekts display_name
terms termina objekts name

Pielāgojiet atbildi ar returnFormat:

JSON
{
  "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"
          }
        }
      }
    ]
  }
}

Ielādes režīms

Iespējojiet dinamisku meklēšanu ar opciju fetch:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "posts",
        "type": "select",
        "label": "Posts",
        "populate": {
          "type": "query",
          "query": "posts",
          "fetch": true,
          "arguments": {
            "post_type": "posts",
            "numberposts": "20"
          }
        }
      }
    ]
  }
}

Tādējādi tiek iespējota stylisedUi, un sākumā tiek ielādētas pirmās 20 ziņas. Ierakstot atlases laukā, tiek meklētas ziņas, izmantojot argumentu s.

Funkcija

Opciju aizpildīšanai izmantojiet pielāgotu funkciju:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "postTypes",
        "type": "checkbox",
        "label": "Post types",
        "populate": {
          "type": "function",
          "function": "get_post_types"
        }
      }
    ]
  }
}

Argumenti

Nododiet argumentus kā masīvu (iekšēji tiek izmantots call_user_func_array):

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "postTypes",
        "type": "checkbox",
        "label": "Post types",
        "populate": {
          "type": "function",
          "function": "get_post_types",
          "arguments": [[], "objects"]
        }
      }
    ]
  }
}

Atgriešanas formāts

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "postTypes",
        "type": "checkbox",
        "label": "Post types",
        "populate": {
          "type": "function",
          "function": "get_post_types",
          "arguments": [[], "objects"],
          "returnFormat": {
            "value": "name",
            "label": "label"
          }
        }
      }
    ]
  }
}

Opciju apvienošana

Apvienojiet statiskās opcijas ar aizpildītajiem datiem:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "users",
        "type": "radio",
        "label": "Users",
        "options": [
          {
            "value": "administrators",
            "label": "Administrators"
          },
          {
            "value": "editors",
            "label": "Editors"
          }
        ],
        "populate": {
          "type": "query",
          "query": "users",
          "position": "before"
        }
      }
    ]
  }
}

Opcija position (before vai after) nosaka aizpildīto opciju novietojumu attiecībā pret statiskajām opcijām.

Brīdinājums

Opciju apvienošana un datu aizpildīšana netiek atbalstīta, izmantojot ielādes režīmu.

Pielāgoti dati

Izveidojiet atkārtoti izmantojamas datu kopas ar filtru blockstudio/blocks/attributes/populate. Filtrs saņem vienu argumentu — masīvu, kurā pēc nosaukumiem indeksētas visas pielāgotās datu kopas. Pievienojiet savu datu kopu ar atslēgu un atgrieziet masīvu:

PHP
add_filter('blockstudio/blocks/attributes/populate', function($options) {
  $options['customData'] = [
    ['value' => '1', 'label' => 'Option 1'],
    ['value' => '2', 'label' => 'Option 2'],
  ];
  return $options;
});

Pēc tam norādiet atslēgu savā blokā:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "posts",
        "type": "select",
        "label": "Posts",
        "populate": {
          "type": "custom",
          "custom": "customData"
        }
      }
    ]
  }
}

Ārējie dati

Ielādējiet datus no ārēja avota:

JSON
{
  "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"
          }
        }
      }
    ]
  }
}

Meklēšanas termins tiek pievienots urlSearch.

Dinamiskie argumenti

Aizpildīšanas argumentos, izmantojot sintaksi {attributes.*}, var atsaukties uz citiem bloka atribūtiem. Mainoties atsauces atribūtam, lauks automātiski ielādē savas opcijas no jauna.

JSON
{
  "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
          }
        }
      }
    ]
  }
}

Tas darbojas ar visiem aizpildīšanas veidiem (query, function, custom). Jebkura aizpildīšanas konfigurācijas vērtība, kas satur {attributes.*}, tiek atrisināta klienta pusē, izmantojot aktuālo atribūta vērtību, pirms tiek palaists vaicājums.

Atsauces izmanto redaktorā saglabātās vērtības. Izvēles saraksta opcijai izmantojiet {attributes.post_type.value}, lai piekļūtu tās vērtībai, vai {attributes.post_type.label}, lai piekļūtu tās etiķetei; returnFormat nosaka veidnes vērtību, nevis šo redaktorā saglabāto datu struktūru.

Ligzdotie argumenti tiek atrisināti, neserializējot tos veidnes virknē. Ja argumentu veido viens vietturis, tiek saglabāts tā atsauces tips, tostarp skaitļi, Būla vērtības, masīvi un objekti. Viettura iegulšana citā tekstā veido virkni. Neatrastas atsauces paliek nemainītas, un citētas vai vairākās rindās izvietotas vērtības tiek nodotas neskartas. Funkciju atzvanāmās funkcijas saglabā savus pozicionālos argumentu sarakstus. Redaktors pievieno WordPress meklēšanas argumentus tikai query aizpildīšanas funkcijām, nevis funkciju izsaukumiem.

Atkarīgo izvēļu attēlošana

Atkarīgās opcijas netiek ielādētas bloka reģistrēšanas laikā, jo katrai bloka instancei var būt atšķirīgi argumenti. Attēlojot bloku, tiek izmantota saglabātā atlase, nevis tā atmesta tukša opciju saraksta dēļ. Aizpildīšanas atzvanāmā funkcija priekšgalā netiek izpildīta atkārtoti.

Laukam joprojām tiek piemērots returnFormat:

returnFormat Vienas variants Vairāki varianti
value (pēc noklusējuma) Saglabātā vērtība, piemēram, "a" Saglabāto vērtību masīvs, piemēram, ["a", "b"]
label Saglabātā etiķete Saglabāto etiķešu masīvs
both Saglabātais variants {value, label} Saglabāto variantu masīvs

Atlasēs, kuru vērtības iegūst no vaicājuma, vērtības joprojām tiek atrisinātas līdz atbilstošajam WordPress ieraksta, lietotāja vai termina objektam, ja vien populate.returnFormat.value nav "id". Etiķetes tiek iegūtas no saglabātās atlases. Ja importētajai atlasei nav etiķetes, tās vērtība tiek izmantota kā etiķete. Atbilstošam statiskam variantam, kas definēts options, ir priekšroka pār saglabāto variantu, tāpēc tiek izmantota tā pašreizējā etiķete.

Tukšas atlases paliek false (vai lauka konfigurētā fallback). Tas nemaina parasto statisko variantu validāciju: ja saglabātās vērtības vairs nav statisko variantu sarakstā, tiek atgriezts false.

Dinamiskās atlases arī saglabā default un fallback atlases, kamēr to varianti vēl nav pieejami. Vairāku variantu atlasei izmantojiet skalāru vērtību, {value, label} variantu vai abu veidu vērtību masīvu. Ja skalārā vērtība neatbilst deklarētam statiskam variantam, tā tiek izmantota kā etiķete. Varianta objekts saglabā tam norādīto etiķeti; atbilstošam statiskam variantam ir priekšroka. Serverī netiek izpildīta aizpildīšanas atzvanfunkcija, lai uzmeklētu šīs noklusējuma vērtības.