Siirry sisältöön

Siirtyminen versioon v7

Tässä oppaassa käsitellään muutoksia, jotka sinun on tehtävä päivittäessäsi versiosta Blockstudio 6 versioon 7.

ES-moduulien tuonnit

Blockstudio 7 tuo ES-moduulien tuonteihin uuden npm:-etuliitteen, joka noudattaa Denon npm-määrittelijä-käytäntöä.

Ennen (v6):

JavaScript
import { h, render } from "blockstudio/preact@10.15.1";
import htm from "blockstudio/htm@3.1.1";
import confetti from "blockstudio/canvas-confetti@1.6.0";

Jälkeen (v7):

JavaScript
import { h, render } from "npm:preact@10.15.1";
import htm from "npm:htm@3.1.1";
import confetti from "npm:canvas-confetti@1.6.0";

CSS-tuonnit

Sama muutos koskee CSS-tuonteja:

Ennen (v6):

JavaScript
import "blockstudio/swiper@11.0.0/swiper.min.css";

Jälkeen (v7):

JavaScript
import "npm:swiper@11.0.0/swiper.min.css";

Taaksepäinyhteensopivuus

blockstudio/-etuliitettä tuetaan edelleen taaksepäinyhteensopivuuden vuoksi. Nykyinen koodisi toimii jatkossakin ilman muutoksia. Suosittelemme kuitenkin siirtymään npm:-etuliitteeseen, jotta käytäntö vastaa laajempaa JavaScript-ekosysteemiä.

npm:-etuliitteellä on useita etuja:

  • Yhteensopivuus ekosysteemin kanssa – Noudattaa Denon vakiintunutta käytäntöä
  • Selkeys – Näet heti, että tuonti tulee kohteesta npm
  • Valmius tulevaan – blockstudio/-etuliite voidaan poistaa käytöstä tulevassa pääversiossa

Hookien nimet

Blockstudio 7 yhdenmukaistaa kaikkien PHP-hookien nimet käyttämään muotoa snake_case muodon camelCase sijaan, jotta ne vastaavat WordPressn ydinkäytäntöjä.

Muuttuneet hookien nimet

Vanha nimi (v6) Uusi nimi (v7)
blockstudio/blocks/components/useblockprops/render blockstudio/blocks/components/use_block_props/render
blockstudio/blocks/components/innerblocks/render blockstudio/blocks/components/inner_blocks/render
blockstudio/blocks/components/innerblocks/frontend/wrap blockstudio/blocks/components/inner_blocks/frontend/wrap
blockstudio/blocks/components/richtext/render blockstudio/blocks/components/rich_text/render
blockstudio/assets/process/scss/importPaths blockstudio/assets/process/scss/import_paths
blockstudio/settings/assets/process/scssFiles blockstudio/settings/assets/process/scss_files
blockstudio/settings/editor/formatOnSave blockstudio/settings/editor/format_on_save
blockstudio/settings/blockEditor/disableLoading blockstudio/settings/block_editor/disable_loading
blockstudio/settings/blockEditor/cssClasses blockstudio/settings/block_editor/css_classes
blockstudio/settings/blockEditor/cssVariables blockstudio/settings/block_editor/css_variables
blockstudio/settings/ai/enableContextGeneration blockstudio/settings/ai/enable_context_generation

Taaksepäinyhteensopivuus

Vanhoja camelCase-muotoisia hookien nimiä tuetaan edelleen taaksepäinyhteensopivuuden vuoksi. Nykyinen koodisi toimii jatkossakin ilman muutoksia. Suosittelemme kuitenkin siirtymään uusiin snake_case-nimiin yhdenmukaisuuden vuoksi.

Esimerkki siirtymisestä:

PHP
// Before (v6)
add_filter('blockstudio/settings/blockEditor/cssClasses', function() {
    return ['my-stylesheet'];
});

// After (v7)
add_filter('blockstudio/settings/block_editor/css_classes', function() {
    return ['my-stylesheet'];
});

Kanoniset lohkotunnisteet

Blockstudio 7.6 säilyttää projektietuliitteet ja tarkat aliakset ajonaikaisina laajennuspisteinä, mutta käyttää muotoa <bs:namespace-slug> esimerkeissä, luettelotulosteissa, renderöinti-ilmoituksissa ja diagnostiikassa. Kanoniset tunnisteet sisältävät rekisteröidyn lohkon todellisen nimen eivätkä riipu isäntäkohtaisesta suodattimesta.

Projektissa, jossa on brand => ["theme-components"] ja ui => ["bsui"]:

HTML
<!-- Legacy project shorthand -->
<brand-card>
  <ui-input />
</brand-card>

<!-- Canonical output -->
<bs:theme-components-card>
  <bs:bsui-input />
</bs:theme-components-card>

Erillinen siirtymiskomento luetteloi olemassa olevan projektin ja kirjoittaa lyhenteet uudelleen kanoniseen muotoon. Se tuottaa ensin raportin, pysähtyy ratkaisemattomien tapausten kohdalla ja muuttaa vain tunnisteiden nimet. Katso Lohkotunnisteiden siirtyminen: komennon ohjeet, syötteet ja turvallisuuskäytäntö.

Resurssitiedostojen nimeäminen

Blockstudio 7 ottaa käyttöön pistekäytännön resurssitiedostojen päätteille ja suosittelee sitä vanhan viivakäytännön tilalle.

Muuttuneet tiedostonimet

Vanha nimi (v6) Uusi nimi (v7)
*-inline.(s)css *.inline.(s)css
*-inline.js *.inline.js
*-editor.(s)css *.editor.(s)css
*-editor.js *.editor.js
*-scoped.(s)css *.scoped.(s)css
*-view.js *.view.js

Taaksepäinyhteensopivuus

Vanhaa viivakäytäntöä tuetaan edelleen taaksepäinyhteensopivuuden vuoksi. Nykyiset tiedostosi toimivat jatkossakin ilman uudelleennimeämistä. Suosittelemme kuitenkin siirtymään pistekäytäntöön uusissa lohkoissa.

Esimerkki siirtymisestä:

Koodi
my-block/
├── block.json
├── index.php
├── style.css
├── style-inline.css   →  style.inline.css
├── style-scoped.css   →  style.scoped.css
├── style-editor.css   →  style.editor.css
├── script.js
├── script-inline.js   →  script.inline.js
├── script-editor.js   →  script.editor.js
└── script-view.js     →  script.view.js

Kentän kytkin

switch-ominaisuuden oletusarvo on nyt false aiemman true-arvon sijaan. Versiossa v6 jokaisessa kentässä oli oletuksena käytössä näkymätön kytkin vasemmassa reunassa. Versiossa v7 kytkin on valinnainen, ja kentän nimessä näkyy silmäkuvake.

Muutokset

  • Oletusarvo on nyt false: kentissä ei enää ole kytkintä, ellet määritä nimenomaisesti arvoa "switch": true
  • Näkyvä silmäkuvake: piilotetun vasemmanpuoleisen napsautusalueen sijaan nimen kohdalla näkyy silmäkuvakkeellinen painike
  • Käytöstä poistetun kentän peite: kun kenttä on poistettu käytöstä, näkyvissä on sumennettu peite ja teksti "Tämä kenttä on poistettu käytöstä" pelkän himmentämisen sijaan

Siirtyminen

Jos hyödynsit version v6 oletusarvoista kytkintoimintaa, ota se käyttöön erikseen:

JSON
{
  "id": "title",
  "type": "text",
  "label": "Title",
  "switch": true
}

Jos määritit aiemmin arvon "switch": false kytkimen poistamiseksi käytöstä, voit poistaa sen, sillä false on nyt oletusarvo.

Tailwind CSS

Blockstudio 7 korvaa kokonaan aiemman v6 Tailwind-toteutuksen. Versiossa v6 Tailwind CSS käännettiin asiakaspuolella editorin CDN-toiminnolla ja tallennettiin levylle julkaisun tallennuksen yhteydessä. Versiossa v7 Tailwind CSS käännetään palvelinpuolella jokaisella käyttöliittymäpyynnöllä linkitetyn tiedostopohjaisen välimuistin avulla: TailwindPHP.

Katso Tailwind CSSdokumentaatiosta kaikki uuden järjestelmän yksityiskohdat.

Aina käytössä oleva palvelinpuolen käännös

Kun tailwind.enabled on true, jokainen käyttöliittymäpyyntö käännetään palvelinpuolella. Käännös etenee näin:

  1. WordPress renderöi koko sivun HTML tulospuskuriin
  2. CSS-luokkakandidaatit poimitaan kohteesta HTML (nopea regex, ei käännöstä)
  3. Kandidaatit lajitellaan ja tiivistetään CSS-asetusten kanssa välimuistiavaimen luomiseksi
  4. Välimuistiosumassa luetaan ja lisätään välimuistiin tallennettu CSS-tiedosto
  5. Välimuistin ohituksessa TailwindPHP kääntää CSSn, tallentaa sen kohteen Blockstudio jaettuun ajonaikaiseen välimuistiin laajuudella tailwind ja lisää sen

Käännetty CSS lisätään sisäisenä <style id="blockstudio-tailwind">-tunnisteena ennen kohdetta </head>. Se sisältää Tailwindn esivalmistelut ja kaikki vastaavat apuluokat.

CDN-skripti pysyy aktiivisena editorissa vain reaaliaikaista esikatselua varten. Sitä ei koskaan tarjota käyttöliittymässä.

config-muoto muuttui

config-ominaisuuden tyyppi muuttui JSON-oliosta (Tailwind v3) tyypiksi CSS-merkkijono (Tailwind v4 CSS-syntaksi ensin).

Ennen (v6):

JSON
{
  "tailwind": {
    "config": {
      "theme": {
        "extend": {
          "colors": {
            "primary": "pink"
          }
        }
      }
    }
  }
}

Jälkeen (v7):

JSON
{
  "tailwind": {
    "config": "@theme { --color-primary: pink; }"
  }
}

customClasses-asetus poistettu

A customClasses-taulukkoasetus on poistettu. Tailwind-lähestymistavassa, jossa v4-luokat määritellään ensin, mukautetut apuluokat määritellään suoraan config-merkkijonossa käyttäen CSS@layer utilities.

Ennen (v6):

JSON
{
  "tailwind": {
    "customClasses": [
      { "className": "btn", "value": "px-4 py-2 rounded-lg font-medium" },
      { "className": "card", "value": "bg-white rounded-xl shadow-lg p-6" }
    ]
  }
}

Jälkeen (v7):

JSON
{
  "tailwind": {
    "config": "@layer utilities { .btn { @apply px-4 py-2 rounded-lg font-medium; } .card { @apply bg-white rounded-xl shadow-lg p-6; } }"
  }
}

Tai suodattimen kautta usean rivin asetuksissa:

PHP
add_filter('blockstudio/settings/tailwind/config', function () {
    return <<<CSS
@layer utilities {
    .btn { @apply px-4 py-2 rounded-lg font-medium; }
    .card { @apply bg-white rounded-xl shadow-lg p-6; }
}
CSS;
});

blockstudio/settings/tailwind/custom_classes-suodatin on myös poistettu. Liitä mukautetut CSS-säännöt sen sijaan blockstudio/tailwind/css-suodattimella.

REST-päätepiste poistettu

POST /blockstudio/v1/editor/tailwind/save-päätepiste on poistettu. Käännettyä CSSä ei enää tallenneta editorista. Jos mukautettu koodisi kutsuu tätä päätepistettä, voit poistaa kutsun turvallisesti.

Välimuisti

Blockstudio käyttää kandidaatteihin perustuvaa välimuististrategiaa. Koko sivun HTMLn tiivistämisen sijaan (mikä tyhjentäisi välimuistin jokaisella pyynnöllä nonce-arvojen ja aikaleimojen vuoksi) tiivistetään vain CSS-luokkakandidaatit. Tämä tarkoittaa seuraavaa:

  • Kaksi sivua, joilla on samat CSS-luokat, käyttävät samaa välimuistitiedostoa
  • Dynaaminen sisältö (nonce-arvot, ylläpitopalkit, aikaleimat) ei tyhjennä välimuistia
  • Välimuisti mitätöityy vain, kun CSS-luokkien joukko tai asetukset muuttuvat

Välimuistitiedostot tallennetaan määritettyyn Blockstudio-ajonaikaisen ympäristön juurihakemistoon polun sites/{network-blog}/{runtime-identity}/tailwind/ alle. Pakota uudelleenkäännös kutsumalla Blockstudio\Runtime_Cache::purge('tailwind').

Suodatinmuutokset

Vanha nimi (v6) Uusi nimi (v7)
blockstudio/tailwind/on_demand/css blockstudio/tailwind/css
blockstudio/tailwind/assets/dir Poistettu
blockstudio/settings/tailwind/custom_classes Poistettu

Poistetut tiedostot ja lataukset

Versiossa v6 Tailwind CSS ladattiin ulkoisina tyylitiedostoina (blockstudio-tailwind, blockstudio-tailwind-preflight). Versiossa v7 kaikki CSS lisätään sisäisesti tulospuskurin kautta. Käyttöliittymässä ei ole kohteen Tailwind linkkitunnisteita eikä ladattuja tyylitiedostoja.

Lohkokirjasto

Sisäänrakennettu “Blockstudio Elements” -kirjasto on poistettu. Kohteen blockstudio.json library-asetuksella ja blockstudio/settings/library-suodattimella ei ole enää vaikutusta.

Jos käytit kirjaston lohkoja (Gallery, Slider, Image Comparison, Code, Icon), kopioi lohkokansiot asennuksesi v6-hakemiston includes/library/blockstudio-element/-kansiosta teemasi blockstudio-hakemistoon ja päivitä niiden block.json-tiedostot uusilla nimillä ja luokilla.