Pereiti prie turinio

Parinkčių užpildymas

Užuot pateikęs skirtingų tipų laukus, tokius kaip įrašai, naudotojai ar terminai, Blockstudio leidžia lanksčiai užpildyti duomenis tiesiai iš block.json. Ši funkcija veikia su select, radio, checkbox, color ir gradient laukų tipais.

Duomenis galima užpildyti keturiais būdais:

  • Užklausa – grąžina įrašų, naudotojų arba terminų užklausos rezultatus
  • Gavimas – grąžina rezultatus iš išorinio šaltinio
  • Funkcija – grąžina tinkintos funkcijos rezultatus
  • Tinkinti duomenys – grąžina tinkinto duomenų rinkinio rezultatus

Užklausa

Pasirinkus užklausos režimą, galima užpildyti įrašų, naudotojų arba terminų duomenis.

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

Galimi užklausų tipai viduje naudoja šias WordPress funkcijas:

Užklausa Funkcija
posts get_posts
users get_users
terms get_terms

Argumentai

Tinkintus argumentus galima perduoti naudojant atributą arguments:

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

Grąžinimo formatas

Pagal numatytuosius nustatymus Blockstudio grąžina:

Užklausa Reikšmė Žyma
posts įrašo objektas post_title
users naudotojo objektas display_name
terms termino objektas name

Tinkinkite atsakymą naudodami 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"
          }
        }
      }
    ]
  }
}

Gavimo režimas

Įjunkite dinaminę paiešką naudodami parinktį fetch:

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

Taip įjungiama stylisedUi, o iš pradžių gaunami pirmieji 20 įrašų. Įvedus tekstą pasirinkimo lauke, įrašų ieškoma pagal argumentą s.

Funkcija

Parinktims užpildyti naudokite tinkintą funkciją:

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

Argumentai

Perduokite argumentus kaip masyvą (viduje naudojama call_user_func_array):

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

Grąžinimo formatas

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

Parinkčių derinimas

Sujunkite statines parinktis su užpildytais duomenimis:

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

Parinktis position (before arba after) nustato, kur užpildytos parinktys rodomos statinių parinkčių atžvilgiu.

Įspėjimas

Derinti parinkčių ir duomenų užpildymo negalima naudojant gavimo režimą.

Tinkinti duomenys

Sukurkite pakartotinai naudojamus duomenų rinkinius naudodami filtrą blockstudio/blocks/attributes/populate. Filtras gauna vieną argumentą – visų tinkintų duomenų rinkinių masyvą, kurio raktai yra pavadinimai. Įtraukite savo duomenų rinkinį naudodami raktą ir grąžinkite masyvą:

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

Tada nurodykite bloko raktą:

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

Išoriniai duomenys

Gaukite duomenis iš išorinio šaltinio:

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

Prie urlSearch pridedamas paieškos terminas.

Dinaminiai argumentai

Užpildymo argumentuose galima nurodyti kitus bloko atributus naudojant sintaksę {attributes.*}. Pasikeitus nurodyto atributo reikšmei, lauko parinktys automatiškai gaunamos iš naujo.

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
          }
        }
      }
    ]
  }
}

Tai veikia su visais užpildymo tipais (query, function, custom). Prieš vykdant užklausą, bet kokia užpildymo konfigūracijos reikšmė, kurioje yra {attributes.*}, kliento pusėje pakeičiama dabartine atributo reikšme.

Nuorodose naudojamos redaktoriuje išsaugotos reikšmės. Pasirinkimo parinkčiai naudokite {attributes.post_type.value} jos reikšmei arba {attributes.post_type.label} jos etiketei; returnFormat valdo šablono reikšmę, o ne šią redaktoriuje išsaugotų duomenų struktūrą.

Įdėtieji argumentai išsprendžiami jų neserializuojant į šablono eilutę. Argumentas, sudarytas iš vienos vietaženklio reikšmės, išsaugo nurodytą tipą, įskaitant skaičius, logines reikšmes, masyvus ir objektus. Vietaženklis, įterptas į kitą tekstą, sukuria eilutę. Nerastos nuorodos paliekamos nepakeistos, o kabutėse esančios ir kelių eilučių reikšmės perduodamos nepakitusios. Funkcijų atgalinio iškvietimo argumentų sąrašų pozicijos išlieka. Redaktorius prideda paieškos argumentus WordPress tik tada, kai query užpildo duomenimis, o ne funkcijų iškvietimams.

Priklausomų parinkčių atvaizdavimas

Priklausomos parinktys neįkeliamos registruojant bloką, nes kiekvienas bloko egzempliorius gali turėti skirtingus argumentus. Atvaizduojant naudojamas išsaugotas pasirinkimas, užuot atmetus jį dėl tuščio parinkčių sąrašo. Užpildymo atgalinio iškvietimo funkcija sąsajoje nebevykdoma.

Lauko returnFormat vis dar taikomas:

returnFormat Vieno pasirinkimo Kelių pasirinkimų
value (numatytoji) Išsaugota reikšmė, pavyzdžiui, "a" Išsaugotų reikšmių masyvas, pavyzdžiui, ["a", "b"]
label Išsaugota etiketė Išsaugotų etikečių masyvas
both Išsaugota {value, label} parinktis Išsaugotų parinkčių masyvas

Užklausos užpildomų pasirinkimų reikšmės vis tiek susiejamos su atitinkamu WordPress įrašo, naudotojo arba termino objektu, nebent populate.returnFormat.value yra "id". Etiketės gaunamos iš išsaugoto pasirinkimo. Jei importuotas pasirinkimas neturi etiketės, kaip etiketė naudojama jo reikšmė. Atitinkanti statinė parinktis, deklaruota options, turi pirmenybę prieš išsaugotą parinktį, todėl taikoma jos dabartinė etiketė.

Tušti pasirinkimai lieka false (arba lauko sukonfigūruota fallback). Tai nekeičia įprastų statinių parinkčių tikrinimo: išsaugota reikšmė, kurios nebėra statinių parinkčių sąraše, vis tiek grąžina false.

Dinaminiai pasirinkimo laukai taip pat išsaugo default ir fallback pasirinkimus, kol jų parinktys atidedamos. Kelių pasirinkimų laukui naudokite skaliarinę reikšmę, parinkties {value, label} objektą arba jų masyvą. Skaliarinė reikšmė naudojama kaip etiketė, nebent ji atitinka deklaruotą statinę parinktį. Parinkties objektas išsaugo pateiktą etiketę; atitinkanti statinė parinktis turi pirmenybę. Serveryje neveikia joks užpildymo atgalinis iškvietimas šioms numatytosioms reikšmėms ieškoti.