Siirry sisältöön

Vaihtoehtojen täyttäminen

Sen sijaan, että tarjoaisit erilliset kenttätyypit julkaisuille, käyttäjille tai termeille, Blockstudio mahdollistaa modulaarisen tavan täyttää tietoja suoraan block.json-näkymästä. Tämä ominaisuus toimii kenttätyyppien select, radio, checkbox, color ja gradient kanssa.

Tietoja voi täyttää neljällä tavalla:

  • Kysely – Palauttaa tulokset julkaisu-, käyttäjä- tai termikyselystä
  • Haku – Palauttaa tulokset ulkoisesta lähteestä
  • Funktio – Palauttaa tulokset mukautetusta funktiosta
  • Mukautettu – Palauttaa tulokset mukautetusta tietojoukosta

Kysely

Kyselytilassa voi täyttää Julkaisut-, Käyttäjät- tai Termit-vaihtoehdot.

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

Käytettävissä olevat kyselytyypit käyttävät sisäisesti näitä WordPress-funktioita:

Kysely Funktio
posts get_posts
users get_users
terms get_terms

Argumentit

Mukautetut argumentit voi välittää arguments-attribuutilla:

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

Palautusmuoto

Oletusarvoisesti Blockstudio palauttaa:

Kysely Arvo Nimiö
posts julkaisun objekti post_title
users käyttäjän objekti display_name
terms termin objekti name

Mukauta vastausta asetuksella 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"
          }
        }
      }
    ]
  }
}

Hakutila

Ota dynaaminen haku käyttöön fetch-asetuksella:

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

Tämä ottaa käyttöön stylisedUi-toiminnon ja hakee aluksi 20 julkaisua. Valintakenttään kirjoittaminen hakee julkaisuja argumentilla s.

Funktio

Täytä vaihtoehdot mukautetulla funktiolla:

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

Argumentit

Välitä argumentit taulukkona (käyttää sisäisesti call_user_func_array-toimintoa):

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

Palautusmuoto

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

Vaihtoehtojen yhdistäminen

Yhdistä staattiset vaihtoehdot täydennettyihin tietoihin:

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

position-vaihtoehto (before tai after) määrittää, missä täydennetyt vaihtoehdot näytetään suhteessa staattisiin vaihtoehtoihin.

Varoitus

Vaihtoehtojen ja tietojen täydennyksen yhdistäminen ei ole tuettua haku-tilassa.

Mukautetut tiedot

Luo uudelleenkäytettäviä tietojoukkoja suodattimella blockstudio/blocks/attributes/populate. Suodatin saa yhden argumentin: taulukon kaikista nimellä avaimistetuista mukautetuista tietojoukoista. Lisää tietojoukko oman avaimensa alle ja palauta taulukko:

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

Viittaa sitten avaimeen lohkossasi:

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

Ulkoiset tiedot

Hae tietoja ulkoisesta lähteestä:

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

Hakutermi lisätään osoitteeseen urlSearch.

Dynaamiset argumentit

Täydennyksen argumenteissa voi viitata lohkon muihin attribuutteihin syntaksilla {attributes.*}. Kun viitattu attribuutti muuttuu, kentän vaihtoehdot haetaan automaattisesti uudelleen.

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

Tämä toimii kaikilla täydennystyypeillä (query, function, custom). Kaikki täydennysmäärityksen arvot, jotka sisältävät {attributes.*}, ratkaistaan asiakaspuolella nykyisen attribuuttiarvon perusteella ennen kyselyn suorittamista.

Viittaukset käyttävät editoriin tallennettuja arvoja. Valintavaihtoehdon arvoksi käytä {attributes.post_type.value} ja sen nimeksi {attributes.post_type.label}; returnFormat määrittää mallineessa käytettävän arvon, ei tätä editoriin tallennettua muotoa.

Sisäkkäiset argumentit ratkaistaan sarjallistamatta niitä mallineen merkkijonoksi. Yhdestä paikkamerkistä koostuva argumentti säilyttää viitteen tyypin, myös numeroiden, totuusarvojen, taulukoiden ja objektien tapauksessa. Muuhun tekstiin upotettu paikkamerkki tuottaa merkkijonon. Puuttuvat viitteet jätetään ennalleen, ja lainausmerkeillä varustetut tai moniriviset arvot välitetään muuttumattomina. Funktiotakaisinkutsut säilyttävät argumenttiluettelonsa ja järjestyksensä. Editorin WordPress-hakuargumentit lisätään vain query-populointeihin, ei funktiokutsuihin.

Riippuvaisten valintojen renderöinti

Riippuvaisia vaihtoehtoja ei ladata lohkoa rekisteröitäessä, koska kunkin lohkoinstanssin argumentit voivat olla erilaisia. Renderöinnissä käytetään tallennettua valintaa sen sijaan, että se hylättäisiin tyhjää vaihtoehtoluetteloa vasten. Populointitakaisinkutsua ei suoriteta uudelleen käyttöliittymässä.

Kentän returnFormat pätee edelleen:

returnFormat Yhden valinta Usean valinta
value (oletus) Tallennettu arvo, esimerkiksi "a" Tallennettujen arvojen taulukko, esimerkiksi ["a", "b"]
label Tallennettu selite Tallennettujen selitteiden taulukko
both Tallennettu {value, label}-vaihtoehto Tallennettujen vaihtoehtojen taulukko

Kyselyllä täytettävissä valinnoissa arvot viittaavat edelleen vastaavaan WordPress-artikkeli-, käyttäjä- tai termiobjektiin, ellei populate.returnFormat.value ole "id". Selitteet saadaan tallennetusta valinnasta. Jos tuodulla valinnalla ei ole selitettä, sen arvoa käytetään selitteenä. Kohdassa options määritetty vastaava staattinen vaihtoehto ohittaa tallennetun vaihtoehdon, joten sen nykyistä selitettä käytetään.

Tyhjät valinnat säilyvät muodossa false (tai kentälle määritettynä arvona fallback). Tämä ei muuta tavallisten staattisten vaihtoehtojen validointia: tallennettu arvo, jota ei enää ole staattisten vaihtoehtojen luettelossa, palauttaa edelleen false.

Dynaamiset valintakentät säilyttävät myös default– ja fallback-valinnat, kun niiden vaihtoehtojen lataamista lykätään. Käytä yksittäistä arvoa, {value, label}-vaihtoehtoa tai jompaakumpaa taulukossa monivalintaa varten. Yksittäisen arvon selitteenä käytetään sen arvoa, ellei se vastaa määritettyä staattista vaihtoehtoa. Vaihtoehto-objektissa säilyy sen annettu selite; vastaava staattinen vaihtoehto ohittaa sen. Palvelin ei suorita täyttökutsua näiden oletusarvojen hakemiseen.