Liigu sisu juurde

Valikute täitmine

Selle asemel et kasutada eri väljatüüpe (nt postitused, kasutajad või terminid), võimaldab Blockstudio andmeid moodulipõhiselt otse block.json kaudu lisada. See funktsioon töötab väljatüüpidega select, radio, checkbox, color ja gradient.

Andmeid saab lisada neljal viisil:

  • Päring – tagastab postituse, kasutaja või termini päringu tulemused
  • Hankimine – tagastab välisest allikast saadud tulemused
  • Funktsioon – tagastab kohandatud funktsiooni tulemused
  • Kohandatud – tagastab kohandatud andmestiku

Päring

Päringurežiimis saab lisada postitusi, kasutajaid või termineid.

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

Saadaolevad päringutüübid kasutavad sisemiselt järgmisi WordPress funktsioone:

Päring Funktsioon
posts get_posts
users get_users
terms get_terms

Argumendid

Kohandatud argumente saab edastada atribuudi arguments abil:

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

Tagastusvorming

Vaikimisi tagastab Blockstudio järgmise:

Päring Väärtus Silt
posts postituse objekt post_title
users kasutaja objekt display_name
terms termini objekt name

Kohandage vastust atribuudiga 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"
          }
        }
      }
    ]
  }
}

Hankimisrežiim

Lülitage dünaamiline otsing sisse valikuga fetch:

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

See lubab stylisedUi ja hangib algselt esimesed 20 postitust. Valikuväljale teksti sisestamine otsib postitusi argumendi s abil.

Funktsioon

Kasutage valikute täitmiseks kohandatud funktsiooni:

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

Argumendid

Edastage argumendid massiivina (kasutab sisemiselt call_user_func_array):

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

Tagastusvorming

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

Valikute kombineerimine

Kombineerige staatilised valikud lisatud andmetega:

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

Valik position (before või after) määrab, kuhu lisatud valikud staatiliste valikute suhtes paigutatakse.

Hoiatus

Valikute ja andmete lisamise kombineerimine pole fetch-režiimis toetatud.

Kohandatud andmed

Looge filtri blockstudio/blocks/attributes/populate abil korduvkasutatavaid andmestikke. Filter saab ühe argumendi: kõigi nime järgi võtmega kohandatud andmestike massiivi. Lisage oma andmestik võtme alla ja tagastage massiiv:

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

Seejärel viidake plokis võtmele:

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

Välised andmed

Hankige andmeid välisest allikast:

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

Otsingusõna lisatakse urlSearch lõppu.

Dünaamilised argumendid

Valikute lisamise argumendid võivad viidata teistele ploki atribuutidele süntaksiga {attributes.*}. Viidatud atribuudi muutmisel hangitakse välja valikud automaatselt uuesti.

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

See töötab kõigi lisamistüüpidega (query, function, custom). Iga lisamise seadistuse väärtus, mis sisaldab {attributes.*}, lahendatakse kliendipoolel jooksvalt enne päringu käivitamist.

Viited kasutavad redaktorisse salvestatud väärtusi. Valikuvõimaluse puhul kasutage {attributes.post_type.value} selle väärtuse või {attributes.post_type.label} selle sildi jaoks; returnFormat juhib malli väärtust, mitte seda redaktoris salvestatud struktuuri.

Pesastatud argumendid lahendatakse neid mallistringiks serialiseerimata. Ühest kohatäitest koosnev argument säilitab sellele viidatud tüübi, sealhulgas arvud, tõeväärtused, massiivid ja objektid. Muu teksti sisse põimitud kohatäitest saab string. Puuduvad viited jäetakse muutmata ning jutumärkides või mitmerealised väärtused edastatakse tervikuna. Funktsiooni tagasihelistused säilitavad oma positsiooniliste argumentide loendid. Redaktor lisab WordPress otsinguargumendid ainult query täitmistele, mitte funktsioonikutsetele.

Sõltuvate valikute renderdamine

Sõltuvaid valikuid ei laadita ploki registreerimisel, sest iga ploki eksemplari argumendid võivad olla erinevad. Renderdamisel kasutatakse salvestatud valikut, selle asemel et see tühja valikuloendi põhjal kõrvale jätta. Täitmise tagasihelistusfunktsiooni kasutajaliideses uuesti ei käivitata.

Välja returnFormat kehtib endiselt:

returnFormat Üksikvalik Mitmikvalik
value (vaikimisi) Salvestatud väärtus, näiteks "a" Salvestatud väärtuste massiiv, näiteks ["a", "b"]
label Salvestatud silt Salvestatud siltide massiiv
both Salvestatud valik {value, label} Salvestatud valikute massiiv

Päringuga täidetud valikute puhul lahendatakse väärtused endiselt vastavaks WordPress postituse, kasutaja või terminiga objektiks, välja arvatud juhul, kui populate.returnFormat.value on "id". Sildid pärinevad salvestatud valikust. Kui imporditud valikul silti pole, kasutatakse sildina selle väärtust. Sobiv staatiline valik, mis on määratletud failis options, on salvestatud valiku suhtes ülimuslik, seega kasutatakse selle praegust silti.

Tühjad valikud jäävad väärtuseks false (või välja seadistatud väärtuseks fallback). See ei muuda tavaliste staatiliste valikute valideerimist: salvestatud väärtus, mida staatiliste valikute loendis enam pole, tagastab endiselt false.

Dünaamilised valikud säilitavad ka default ja fallback valikud ajal, mil nende valikuloendit alles koostatakse. Kasutage skalaarväärtust, valikuobjekti {value, label} või nende massiivi mitmikvaliku korral. Skalaar kasutab sildina oma väärtust, välja arvatud juhul, kui see vastab määratletud staatilisele valikule. Valikuobjekt säilitab talle antud sildi; sobiv staatiline valik on ülimuslik. Serveris ei käivitata vaikeväärtuste otsimiseks ühtegi täitmise tagasihelistusfunktsiooni.